online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.customer.title
List Customers
Overview
Retrieve Customer List of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/customer/list.html?token=XXXXXXXX&userId={userId}
Arguments
clientId
required
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
Filter or Search Criteria
customerType By customer type. Either name or ID (RESIDENTIAL-1 or BUSINESS-2)
name By name of customer
lastName By last name of customer
companyName If customer is of business type (by company name)
externalId By external ID of customer
workOrderId By work order ID of customer
assignedTo By assignedTo - accepts either name (lastname, firstname) or userId
phoneNumber By phone number
address By address of customer
radius If address is provided, radius is in miles near by address
category By category - accepts either category name or category ID
createdBy By create user - accepts either name (lastname, firstname) or userId
Return
Returns a list of Customer Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 customers will be returned. Returns an error if not a valid request
Request Body XSD
Response Body XSD
Curl Example
HTTP Method: POST
Request: curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/customer/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request><customerType>RESIDENTIAL</customerType><createdBy>Smith, John</createdBy></request>'
Response: <?xml encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">
<customerList>
<totalAvailableCount>55</totalAvailableCount>
<count>55</count>
<customer>
<mobiworkCustomerId>501266</mobiworkCustomerId>
<externalCustomerId>API4444</externalCustomerId>
<companyName>API Test</companyName>
<fromDate>05/19/2021</fromDate>
<type>BUSINESS</type>
<statusId>589</statusId>
<enabled>true</enabled>
<assignedTo></assignedTo>
<closingDate></closingDate>
<prospectFlag>false</prospectFlag>
<address>
<addressId>818635</addressId>
<address1>160 Congress Park Dr</address1>
<address2></address2>
<city>Delray Beach</city>
<state>Florida</state>
<zipCode>33445</zipCode>
<countryId>1</countryId>
<latitude>26.4582132</latitude>
<longitude>-80.0940502</longitude>
<name>Primary Address</name>
<baseDistance>9022407</baseDistance>
</address>
<contact>
<contactId>685033</contactId>
<customerId>501266</customerId>
<firstName>API4</firstName>
<lastName>API4</lastName>
<title></title>
<email></email>
<phoneNumber>516156111</phoneNumber>
<altPhoneNumber></altPhoneNumber>
<phoneExt></phoneExt>
<altPhoneExt></altPhoneExt>
<pin>8921</pin>
<enabled>true</enabled>
<createdDate>Mon Sep 26 06:35:29 EDT 2016</createdDate>
<fax></fax>
<admin>true</admin>
<employeeId></employeeId>
<loginId></loginId>
<password></password>
</contact>
<addressList></addressList>
<contactList></contactList>
<customFields>
<customField>
<fieldType>4</fieldType>
<apiName>ServiceContract</apiName>
<index>0</index>
<value>false</value>
<name>Service Contract?</name>
</customField>
<customField>
<fieldType>4</fieldType>
<apiName>ServiceContract</apiName>
<index>0</index>
<value>false</value>
<name>Service Contract?</name>
</customField>
</customFields>
<mobiForms>
<mobiForm>
<filledFormId>1034</filledFormId>
<apiName>CustomFields</apiName>
<name>Custom Fields</name>
<pdfUrl></pdfUrl>
<createdDate>05/19/2021</createdDate>
<name>Custom Fields</name>
<customFields>
<customField>
</customField>
</customFields>
</mobiForm>
</mobiForms>
</customer>
<customer>
<mobiworkCustomerId>501266</mobiworkCustomerId>
<externalCustomerId>API4444</externalCustomerId>
<companyName>API Test</companyName>
<fromDate>05/19/2021</fromDate>
<type>BUSINESS</type>
<statusId>589</statusId>
<enabled>true</enabled>
<assignedTo></assignedTo>
<closingDate></closingDate>
<prospectFlag>false</prospectFlag>
<address>
<addressId>818635</addressId>
<address1>160 Congress Park Dr</address1>
<address2></address2>
<city>Delray Beach</city>
<state>Florida</state>
<zipCode>33445</zipCode>
<countryId>1</countryId>
<latitude>26.4582132</latitude>
<longitude>-80.0940502</longitude>
<name>Primary Address</name>
<baseDistance>9022407</baseDistance>
</address>
<contact>
<contactId>685033</contactId>
<customerId>501266</customerId>
<firstName>API4</firstName>
<lastName>API4</lastName>
<title></title>
<email></email>
<phoneNumber>516156111</phoneNumber>
<altPhoneNumber></altPhoneNumber>
<phoneExt></phoneExt>
<altPhoneExt></altPhoneExt>
<pin>8921</pin>
<enabled>true</enabled>
<createdDate>Mon Sep 26 06:35:29 EDT 2016</createdDate>
<fax></fax>
<admin>true</admin>
<employeeId></employeeId>
<loginId></loginId>
<password></password>
</contact>
<addressList></addressList>
<contactList></contactList>
<customFields>
<customField>
<fieldType>4</fieldType>
<apiName>ServiceContract</apiName>
<index>0</index>
<value>false</value>
<name>Service Contract?</name>
</customField>
<customField>
<fieldType>4</fieldType>
<apiName>ServiceContract</apiName>
<index>0</index>
<value>false</value>
<name>Service Contract?</name>
</customField>
</customFields>
<mobiForms>
<mobiForm>
<filledFormId>1034</filledFormId>
<apiName>CustomFields</apiName>
<name>Custom Fields</name>
<pdfUrl></pdfUrl>
<createdDate>05/19/2021</createdDate>
<name>Custom Fields</name>
<customFields>
<customField>
</customField>
</customFields>
</mobiForm>
</mobiForms>
</customer>
</customerList>
</response>