Skip to main content
GET
List clients

Authorizations

x-api-key
string
header
required

Query Parameters

crmEntityId
string

Return only the client with this external CRM entity id (unique per org). Ignores pagination.

email
string

Return only the client with this email address. The match is exact and case-sensitive against the stored value. Emails are not guaranteed unique within an organization, so at most one matching client is returned. Encode + in an email as %2B (a literal + in a query string decodes to a space). Ignores pagination; ignored when crmEntityId is also given; an empty value is ignored and the request returns the paginated list.

limit
integer
default:25

Number of results to return.

Required range: 1 <= x <= 100
startAfter
string

Opaque pagination cursor. Pass the nextCursor value from the previous response.

Response

OK

clients
object[]
nextCursor
string | null

Opaque cursor for the next page, or null when there are no more results.

hasMore
boolean