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
integer

1-indexed page number for pagination.

Required range: x >= 1
Example:

1

pageSize
integer

Number of results per page. Maximum 100; larger values are clamped to 100, and totalResults still reports the full count so you can page through the rest.

Required range: x >= 1
Example:

25

name
string

Case-insensitive substring filter applied to the customer's name.

Example:

"claudio"

email
string

Case-insensitive substring filter applied to any of the customer's email addresses.

Example:

"example.com"

Response

Successful operation

customers
object[]

The page of customer records that match the supplied filters.

totalResults
integer

Total number of customers matching the filters across all pages.