Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[cursor]
string

Opaque cursor from meta.pagination.next_cursor or prev_cursor of a previous response.

page[limit]
integer

Number of customers to return. Defaults to 20.

Required range: 1 <= x <= 100
sort
enum<string>

Sort order. Prefix with - for descending. Defaults to -created_at.

Available options:
created_at,
-created_at,
name,
-name
filter[name]
string

Case-insensitive partial match on the customer's name.

filter[email]
string

Case-insensitive partial match on the customer's email.

filter[external_id]
string

Exact match on the customer's external id.

filter[created_at]
string

Creation date range as start/end. An end date with no time of day covers that whole day. An unreadable range returns 422.

Response

Success

customers
object[]
meta
object