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

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customerType"/>
        <xs:element ref="name"/>
        <xs:element ref="lastName"/>
        <xs:element ref="assignedTo"/>
        <xs:element ref="externalId"/>
        <xs:element ref="workOrderId"/>
        <xs:element ref="phoneNumber"/>
        <xs:element ref="address"/>
        <xs:element ref="radius"/>
        <xs:element ref="category"/>
        <xs:element ref="createdBy"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customerType" type="xs:NCName" minOccurs="0"/>
  <xs:element name="name" type="xs:string" minOccurs="0"/>
  <xs:element name="lastName" type="xs:NCName" minOccurs="0"/>
  <xs:element name="assignedTo" type="xs:string" minOccurs="0"/>
  <xs:element name="externalId" type="xs:integer" minOccurs="0"/>
  <xs:element name="workOrderId" type="xs:integer" minOccurs="0"/>
  <xs:element name="phoneNumber" type="xs:integer" minOccurs="0"/>
  <xs:element name="address" type="xs:string" minOccurs="0"/>
  <xs:element name="radius" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="category" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="createdBy" minOccurs="0">
    <xs:complexType/>
  </xs:element>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customerList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="customerList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element maxOccurs="unbounded" ref="customer"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="customer">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkCustomerId"/>
        <xs:element ref="externalCustomerId"/>
        <xs:element ref="companyName"/>
        <xs:element ref="fromDate"/>
        <xs:element ref="type"/>
        <xs:element ref="statusId"/>
        <xs:element ref="enabled"/>
        <xs:element ref="assignedTo"/>
        <xs:element ref="address"/>
        <xs:element ref="contact"/>
        <xs:element ref="addressList"/>
        <xs:element ref="contactList"/>
        <xs:element ref="customFields"/>
        <xs:element ref="mobiForms"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkCustomerId" type="xs:integer"/>
  <xs:element name="externalCustomerId" type="xs:integer"/>
  <xs:element name="companyName" type="xs:string"/>
  <xs:element name="fromDate" type="xs:string"/>
  <xs:element name="type" type="xs:NCName"/>
  <xs:element name="statusId" type="xs:integer"/>
  <xs:element name="assignedTo" type="xs:string"/>
  <xs:element name="address">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="addressId"/>
        <xs:element ref="address1"/>
        <xs:element ref="address2"/>
        <xs:element ref="city"/>
        <xs:element ref="state"/>
        <xs:element ref="zipCode"/>
        <xs:element ref="countryId"/>
        <xs:element ref="latitude"/>
        <xs:element ref="longitude"/>
        <xs:element ref="name"/>
        <xs:element ref="baseDistance"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="addressId" type="xs:integer"/>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="address2" type="xs:string"/>
  <xs:element name="city" type="xs:string"/>
  <xs:element name="state" type="xs:NCName"/>
  <xs:element name="zipCode" type="xs:integer"/>
  <xs:element name="countryId" type="xs:integer"/>
  <xs:element name="latitude" type="xs:decimal"/>
  <xs:element name="longitude" type="xs:decimal"/>
  <xs:element name="baseDistance" type="xs:integer"/>
  <xs:element name="contact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="contactId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="title"/>
        <xs:element ref="email"/>
        <xs:element ref="phoneNumber"/>
        <xs:element ref="altPhoneNumber"/>
        <xs:element ref="phoneExt"/>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="officePhone"/>
        <xs:element ref="officePhoneExt"/>
        <xs:element ref="pin"/>
        <xs:element ref="enabled"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="fax"/>
        <xs:element ref="admin"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="contactId" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="firstName" type="xs:NCName"/>
  <xs:element name="lastName" type="xs:NCName"/>
  <xs:element name="title" type="xs:NCName"/>
  <xs:element name="email" type="xs:string"/>
  <xs:element name="phoneNumber" type="xs:integer"/>
  <xs:element name="altPhoneNumber" type="xs:integer"/>
  <xs:element name="phoneExt" type="xs:integer"/>
  <xs:element name="altPhoneExt" type="xs:integer"/>
  <xs:element name="officePhone" type="xs:integer"/>
  <xs:element name="officePhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="pin" type="xs:integer"/>
  <xs:element name="fax" type="xs:integer"/>
  <xs:element name="admin" type="xs:boolean"/>
  <xs:element name="addressList">
    <xs:complexType/>
  </xs:element>
  <xs:element name="contactList">
    <xs:complexType/>
  </xs:element>
  <xs:element name="mobiForms">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="mobiForm"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiForm">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="filledFormId"/>
        <xs:element ref="apiName"/>
        <xs:choice maxOccurs="unbounded">
          <xs:element ref="createdDate"/>
          <xs:element ref="name"/>
          <xs:element ref="pdfUrl"/>
        </xs:choice>
        <xs:element ref="customFields"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="filledFormId" type="xs:integer"/>
  <xs:element name="pdfUrl">
    <xs:complexType/>
  </xs:element>
  <xs:element name="enabled" type="xs:boolean"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="customFields">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="customField"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customField">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="fieldType"/>
        <xs:element ref="apiName"/>
        <xs:element ref="index"/>
        <xs:element ref="value"/>
        <xs:element ref="name"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="fieldType" type="xs:integer"/>
  <xs:element name="index" type="xs:integer"/>
  <xs:element name="value" type="xs:string"/>
  <xs:element name="apiName" type="xs:NCName"/>
</xs:schema>

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>