Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Query Parameters

after
string<uuid>

Return items that come after this cursor

before
string<uuid>

Return items that come before this cursor

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
email
string

Filter by exact customer email address

Maximum string length: 255
name
string

Filter by exact customer name

Maximum string length: 255
createdAt
object

Filter by creation date using range operators: gt, gte, lt, lte

Response

A paginated list of customer objects.

Response list object

data
Customer · object[]
required
pagination
object
required

Pagination metadata including cursors for navigating through results