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

order_by
string

Sort order. Format: column.direction. Allowed columns: name, email, alias, created_at. Direction: asc or desc. Default: created_at.desc.

page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100
archived
boolean

Response

List of customers

data
object[]
required
pagination_meta
object
required