Skip to main content
GET
List customers

Authorizations

x-api-key
string
header
required

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

limit
number
default:20

Maximum number of results to return (1-100)

Required range: 1 <= x <= 100
direction
enum<string>

Pagination direction relative to the cursor

Available options:
forward,
backward
clientReferenceId
string

Filter to the customer with this client reference ID. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.

type
string[]

Filter by one or more customer types.

sortBy
enum<string>
Available options:
createdAt,
updatedAt,
type
sortOrder
enum<string>
Available options:
asc,
desc

Response

data
object[]
required
meta
object
required