Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_), used exactly as shown in the dashboard. Endpoints that support sandbox data take an explicit environment field or parameter. All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Query Parameters

limit
integer
default:20

Maximum number of customers to return per page (1–100).

Required range: 1 <= x <= 100
starting_after
string

Cursor for the next page: pass the next_cursor value from the previous response unchanged.

sort_by
string

Field to sort results by.

sort_order
enum<string>

Sort direction.

Available options:
asc,
desc
environment
enum<integer>

Filter by environment: 0 = sandbox, 1 = production.

Available options:
0,
1

Search query string.

filter[status][]
string[]

Filter by customer status. Repeatable: filter[status][]=active&filter[status][]=churned.

filter[target_platform][]
string[]

Filter by target platform. Repeatable.

Response

A paginated list of customers.

object
enum<string>
required
Available options:
list
url
string
required
Example:

"/v4/customers"

data
object[]
required
has_more
boolean
required

true when more customers are available after this page.

next_cursor
string

Opaque cursor for the next page. Present only when has_more is true; pass it unchanged as starting_after to fetch the next page.

Example:

"Y3VzdDoy"