GET
/
customers

Authorizations

Authorization
string
headerrequired

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

Query Parameters

expand
string[]

Fields to expand related entities. For example, ["organization"].

take
number

Maximum number of items to retrieve. Default is 25.

skip
number

Number of items to skip before starting to collect the result set.

orderBy
string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

search
string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Response

200 - application/json
data
object[]
required
count
number
required

Total count of customers