Skip to main content
GET
List customers

Authorizations

X-API-KEY
string
header
required

API Key Authentication.

Query Parameters

Free-text search over customer name, exact external id, and payment account tax id.

includeArchived
boolean
default:false

Whether archived customers should be returned.

offset
number
default:0

Number of items to skip before collecting the page.

Required range: x >= 0
limit
number
default:100
required

Maximum number of items to return per page.

Required range: 1 <= x <= 100

Response

200 - application/json

Default Response

items
object[]
required

A list of items.

hasMore
boolean
required

Indicates if there are more items to fetch.