Customers

List customers

View as Markdown
Returns a paginated list of customers. Supports filtering by email, status, and external ID.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Query parameters

limitintegerOptional1-100Defaults to 20

Maximum number of items to return (1-100).

offsetintegerOptional>=0Defaults to 0
Number of items to skip before returning results.
emailstringOptional

Filter customers by email address (partial match).

statusenumOptional
Filter by customer status.
Allowed values:
external_idstringOptional
Filter by your application's external identifier.

Response

A paginated list of customers
datalist of objects
paginationobject

Errors

401
Unauthorized Error