Skip to main content
POST
Query customers

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

customer_ids
string[]
email
string
end_time
string<date-time>
expand
string
external_id
string
external_ids
string[]
filters
object[]
limit
integer
Required range: 1 <= x <= 1000
metadata
object
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
sort
object[]
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived

Response

OK

Response object for listing customers with pagination

items
object[]
pagination
object