Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Query Parameters

status
enum<string>

Filter by status. Default returns all.

Available options:
active,
inactive
email
string

Filter by exact email match.

externalId
string

Filter by externalId.

createdAfter
string<date-time>

Filter customers created after this timestamp.

createdBefore
string<date-time>

Filter customers created before this timestamp.

limit
integer
default:20
Required range: x <= 100
cursor
string

Response

List of customers

data
object[]
required
hasMore
boolean
required
cursor
string

Opaque pagination cursor — pass back as the cursor query param to fetch the next page. Absent on the last page.