searchCustomers

Find all customers matching the provided set of criteria

Details

Responses and Response Schema

200 (Customers Found)

The 200 response consists of an array[object] consisting of the following fields.

Field NameTypeDescription
id*string
url*string

Format: uri
The URI the agent can click on to see the customer.
customNonSearchableCustomerFieldOnestringThese will only be present if specified via the /meta/object/customer endpoint.
customNonSearchableCustomerFieldTwostringThese will only be present if specified via the /meta/object/customer endpoint.
customSearchableCustomerFieldOnestringThese will only be present if specified via the /meta/object/customer endpoint.
customSearchableCustomerFieldTwostringThese will only be present if specified via the /meta/object/customer endpoint.
204 (No Customers Found)

No customers found matching criteria.

400 (Invalid Field in Payload)

Invalid field in payload. Generic errors.

Field NameTypeDescription
fieldsobeject
error*stringThe name of the error or code.
message*stringMessage passable to the user.
fields object
Field NameType
name*string
errorMessage*string
401 (API Key is Invalid)

API key is invalid or has become de-authenticated.

500 (Unexpected Error)

Unexpected error.

Field NameTypeDescription
error*stringName of the error or code.
message*stringMessage passable to the user.
Language
URL