list

GET

/v1/customers

curl --request GET \
  --url https://example.com/v1/customers \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer_auth

Parameters

Query Parameters

email

string

nullable

Filter by email address (exact match).

external_id

string

nullable

before

string format: date-time

nullable

Cursor: created_at of the last item from the previous page.

limit

integer format: int32

nullable

Page size 1–100. Defaults to 25.

Responses

200

List of customers

Media type application/json

Array<object>

object

created_at

required

string format: date-time

deleted_at

string format: date-time

nullable

email

string

nullable

external_id

string

nullable

id

required

string format: uuid

idempotency_key

required

string

metadata

required

name

string

nullable

phone

string

nullable

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

Example ^generated

[
  {
    "created_at": "2026-04-15T12:00:00Z",
    "deleted_at": "2026-04-15T12:00:00Z",
    "email": "example",
    "external_id": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "idempotency_key": "example",
    "metadata": "example",
    "name": "example",
    "phone": "example",
    "tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "updated_at": "2026-04-15T12:00:00Z"
  }
]

401

Unauthorized