Skip to main content
GET
List Customers

Authorizations

X-Authorization
string
header
required

API Scope: "Customers (read)"

Query Parameters

external_id
string

An external_id used to filter the customers.

Maximum string length: 64
Example:

"28hs67udfh-213csss-12d31ja"

limit
integer
default:50

The maximum number of customers returned.

Required range: x <= 250
Example:

20

sort_order
enum<string>
default:asc

The sort order for the results.

Available options:
asc,
desc
Example:

"asc"

cursor
string

The cursor to return the next page of results.

Response

Success

customers
object[]
required
next_page_url
string | null
previous_page_url
string | null