Customer list

Search and retrieve customers based on filter criteria

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 256

Customer Id associated with the customer

string
length ≤ 256

Customer Account number

string

The customer's first name

string

The customer's last name

string

The customer's date of birth

string

Country specific Tax Id associated with this customer (SIN or NAS in Canada, SSN or TIN in US, etc.)

string

Customer's email address

string

Customer's telephone number

string

The business or organization name to be searched on

string

This value is searched against first, last, and middle names

string

The party identifier associated with the customer

string

Account type

date
length ≤ 10

Start time for use in retrieval of elements (ISO 8601)

date
length ≤ 10

End time for use in retrieval of elements (ISO 8601)

string

Opaque cursor used by the provider to send the next set of records

integer

Number of elements that the consumer wishes to receive. Providers should implement reasonable default and maximum values

Headers
uuid
required

A unique request identifier associated with the request. It's typically a UUID generated for each request, can be used for request tracking purposes.

string

It's an optional header that identifies the end-user of client application. In some cases, client application is expected to send CustomerId associated with the authenticated user.

string

It's an optional header used for internal purposes. It's an alias that overrides the default tenant associated with the authorization token.

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json