Features - Connectors Framework - Inbound REST API - Customers
List Customer Custom Status
Overview
Retrieve Customer Custom Status List defined in customer settings of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/customer/customStatus/list.html?token=XXXXXXXX&userId={userId}
Arguments
clientIdrequired MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: 10.0.78
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
userId
optional
If provided, this User ID will be taken as a logged in user
Return
Returns a list of customer custom status defined in customer settings if valid arguments are provided. Returns an error if not a valid request
Request Body XSD
None
Response Body XSD
Example
HTTP Method: POST
Request: curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/customer/customStatus/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml'
Response: <?xml encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">
<customStatusList type="Customer">
<customStatus>Roofing Estimate Out</customStatus>
<customStatus>Lead</customStatus>
</customStatusList>
</response>