Skip to navigation

List customers

View as Markdown

Returns up to 1000 customers per call. Use customerIDafter for pagination. Rate limit: 20 requests/second.

Authentication

Authorizationstring

Format: ApiKey <your_key>

Query parameters

dateFromUtcintegerOptional

Unix timestamp (seconds)

dateToUtcintegerOptional
dateModifiedFromUtcintegerOptional
dateModifiedToUtcintegerOptional
customerIDintegerOptional
externalIDstringOptional
customerIDafterintegerOptional

Cursor – returns customers with ID after this value

steptypesstringOptional

Comma-separated. Values: inquiry, declined, buyer, all

typesstringOptional

Values: real, test, all

sortenumOptional
Allowed values:

Response

List of customers
StatusintegerOptional
Customerslist of objectsOptional