Skip to main content
POST
Required scopes: customers:ro

Authorizations

​
Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
​
query
string

The free-text query to match against the name, email, suggested_email, and phone_number fields. The API excludes fields that are explicitly filtered.

Minimum string length: 3
Example:

"john smith"

​
filters
object[]

An array of filter groups combined with AND logic.

​
results_per_page
integer
default:50

The number of results to return per page.

Required range: 1 <= x <= 100
​
sort
object

The sorting configuration. Each key is a sortable field name or customer property ID, and key order sets the sort priority. Customer properties of type text are not sortable. The API appends created_at as the final sort field for stable pagination.

Example:
​
page_id
string

The page number as a numeric string. The first page is 1. To retrieve the next page, use the next_page_id from the previous response.

Example:

"1"

Response

A list of customers matching the search criteria.

​
customers
object[]
required

An array of customer objects matching the search criteria.

​
total
integer<int32>
required

The total number of customers matching the search criteria.

Example:

1523

​
page_id
string
required

The current page identifier.

Example:

"1"

​
next_page_id
string

The page identifier for the next page of results. Omitted when there are no more pages. To retrieve the next page, pass this value as page_id in the next request.

Example:

"2"