Skip to main content
GET
List clients

Authorizations

X-API-KEY
string
header
required

Query Parameters

limit
integer

Maximum number of clients to return

nextToken
string

Pagination cursor returned by a previous call

companyId
string

Filter by company ID

givenName
string

Filter by client given (first) name

familyName
string

Filter by client family (last) name

email
string

Filter by client email

customFields
object

Filter by tag-based custom field values. Repeatable bracket-style param: customFields[]=[,...]. Values within a single bracket are matched with OR; multiple bracketed fields are combined with AND. Only multi-select custom fields are supported.

Response

OK

data
object[]
nextToken
string

base64 encoded JSON representing a NextToken