Get a list of customers

This endpoint returns a list of customers that match the specified search criteria.

The response includes partial information for each customer, including essential fields from the customer profile, risk level, and status objects.

Complete details for each customer can be retrieved by calling the relevant endpoint with a specific customer identifier.

This endpoint can return up to 10,000 customers. For larger datasets, use the 'exports' endpoint, which is designed for exporting large volumes of data.

You need the "View customers" permission to use this endpoint.

Query Params
string

Search customers by name or external identifier

date-time
date-time
date-time
date-time
string
string
string
boolean
acquisition_source
array of strings
acquisition_source
segments
array of strings
segments
labels
array of strings
labels
string
industry_code
array of strings
industry_code
industry_code_description
array of strings
industry_code_description
integer
≥ 1
Defaults to 1

One-based page index (1..N)

integer
≥ 1
Defaults to 50

The size of the page to be returned

Responses

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