Skip to main content
GET
List Customers

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

simulatedAt
string<date-time>

Optional: the simulatedAt datetime

branchId
string

Optional: the branchId

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
offset
number
default:0

the pagination offset

pageSize
number
default:50

the pagination page size

Response

200 - application/json
total
number
required

Total number of customers

offset
number
required

Offset used for pagination

limit
number
required

Page size used for pagination

data
object[]
required

List of customers