Skip to main content
GET
List Customers

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Query Parameters

limit
integer
default:25

How many items to return, 1 to 100.

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

The nextCursor from the previous page. Leave it out for the first page.

externalId
string

Only the customer with this externalId (your own id for it). Exact match.

Maximum string length: 128
archived
enum<string>
default:false

true lists only deleted customers that are waiting to be erased; false (the default) lists only live ones.

Available options:
true,
false
createdAfter
string<date-time>

Only customers created after this ISO 8601 time.

createdBefore
string<date-time>

Only customers created before this ISO 8601 time.

Response

A page of customers.

items
object[]
required
nextCursor
string | null
required

Pass as cursor for the next page; null on the last page.