v1
latestOpenAPI 3.0.32026-07-24148824715.6 KBCustomers
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.
get/v2/customers
Query parameters
searchstring
Search customers by name or external identifier
created_at_fromstring date-time
Example:2024-01-01T00:00:00.000Z
created_at_tostring date-time
Example:2024-12-31T23:59:59.000Z
updated_at_fromstring date-time
Example:2024-01-01T00:00:00.000Z
updated_at_tostring date-time
Example:2024-12-31T23:59:59.000Z
typestring
Example:PERSON
risk_levelstring
Example:HIGH
statusstring
Example:ACTIVE
monitoring_enabledboolean
Example:true
acquisition_sourcestring[]
[ "web" ]
segmentsstring[]
[ "segment-1" ]
labelsstring[]
[ "label-1" ]
sortstring
Example:-created_at
industry_codestring[]
[ "ABC123" ]
industry_code_descriptionstring[]
[ "Description of the industry code" ]
page_numberinteger
One-based page index (1..N)
page_sizeinteger
The size of the page to be returned
Response
Get the list of customers