v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB

Customers

List customers

Returns a paginated list of customers for the authenticated project. Manifest-compliant: list envelope, ISO 8601 timestamps.

get/customers

pageinteger

Page number (1-based).

limitinteger

Maximum number of customers to return.

sort_bystring

Field to sort results by.

sort_order'asc' | 'desc'

Sort direction.

environment0 | 1

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

searchstring

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.

A paginated list of customers.

object'list' required

urlstring required

dataobject[] required

has_moreboolean required

next_cursorstring

Present only when has_more is true.

{
  "url": "/v4/customers"
}