findCustomer

Returns info for a specific customer

Details

Responses and Response Schema

200 (Customer Response)

Customer created successfully.

Field Name

Type

Description

id*

string

url*

string

Format: uri

The URI the agent can click on to see the customer.

customNonSearchableCustomerFieldOne

string

These will only be present if specified via the createCustomer endpoint.

customNonSearchableCustomerFieldTwo

string

These will only be present if specified via the createCustomer endpoint.

customSearchableCustomerFieldOne

string

These will only be present if specified via the createCustomer endpoint.

customSearchableCustomerFieldTwo

string

These will only be present if specified via the createCustomer endpoint.

400 (Invalid Field in Payload)

Invalid field in payload. Generic errors.

Field Name

Type

Description

error*

string

The name of the error or code.

message*

string

Message passable to the user.

401 (API Key is Invalid)

API key is invalid or has become de-authenticated.

404 (Customer Not Found)

No customer exists with the provided ID.

500 (Unexpected Error)

Unexpected error.

Field Name

Type

Description

error*

string

Name of the error or code.

message*

string

Message passable to the user.

Language
URL