Finds and returns unique identifiers for all Customers that match a given criteria.
| Get | api/customers |
Resource Path: /sites/{company-id}/api/customers
Uri: https://secure.ontime360.com/sites/{company-id}/api/customers
| Name | Description | Data Type |
|---|---|---|
accountNumber (query) | The account number of a Customer as a String. | string |
addressLine1 (query) | The exact street address of a Customer as a String. | string |
city (query) | The city or locality a Customer resides within as a String. | string |
country (query) | The country or national political entity of a Customer as a String. | string |
email (query) | The email of a Customer as a String. | string |
inactive (query) | The active status of a Customer as a Boolean. | boolean |
name (query) | The name of a Customer as a String. | string |
postalCode (query) | The postal code of a Customer as a String. | string |
primaryContactName (query) | Name of the primary contact of a Customer as a String. | string |
referenceNumber (query) | The reference number of a Customer as a String. | string |
state (query) | The state, province, or other civil entity a Customer resides within as a String. | string |
lastModifiedDateMin (query) | The inclusive minimum last modified date of a Customer as a Date. | string |
lastModifiedDateMax (query) | The inclusive maximum last modified date of a Customer as a Date. | string |
creationDateMin (query) | The inclusive minimum creation date of a Customer as a Date. | string |
creationDateMax (query) | The inclusive maximum creation date of a Customer as a Date. | string |
The response body is of type Array[].
An array of unique Guid identifiers assigned to matching Customer objects.| Fault | Description |
|---|---|
| 400 | Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information. |
| 401 | Authorization key is invalid or no longer exists. |
| 403 | Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information. |