All versions ->

Copy link to request setupRun requestRun
GET/v2/customers

List customers

Sign in
SandboxProduction

Access Tokens

Sign in to populate your access tokens from the developer dashboard Sign in

Link to section

Parameters

count

boolean

cursor

string

A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field's value.

limit

integer(32-bit)

sort_field

string

Use the default sort key. By default, customers are sorted alphanumerically by concatenating their given_name and family_name. If neither name field is set, string comparison is performed using one of the remaining fields in the following order: company_name, email, phone_number.

Use the creation date attribute (created_at) of customer profiles as the sort key.

sort_order

string

The results are returned in descending (e.g., newest-first or Z-A) order.

The results are returned in ascending (e.g., oldest-first or A-Z) order.

GET /v2/customers

Response

// No response received yet.