Skip to main content
GET
cURL

Authorizations

integration_id
string
header
required

Identifier of the integration (Auth v1)

secret
string
header
required

Secret of the organization (Auth v1)

x-api-key
string
header
required

API key (Auth v2)

Query Parameters

start_date
string

Start date

end_date
string

End date

skip
string

Number of clients to skip

limit
string

Number of clients to return

resource_type
string

Filter the clients that have purchased that resource type. The clients are then listed in client id order and, combined with start_date/end_date, a page can hold fewer than limit clients: keep paging until an empty page.

email
string

Filter clients by exact email match within the authenticated organization.

phone
string

Exact match. Country code + digits only, no separators. URL-encode the + as %2B (e.g. %2B34600000000).

Response

HTTP OK

success
boolean
Example:

true

data
object[]

Array of Client