Skip to main content
GET
List Users

Authorizations

Authorization
string
header
required

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

Query Parameters

search
string | null

Search for users by name or email.

exact_match
boolean
default:false

Only return users whose name or email equals search exactly.

expand
string[] | null

Fields to expand. Supported fields: custom_attributes.

page_token
string | null

Opaque cursor from a previous response's next_page_token. Omit to fetch the first page. Treat as opaque: do not decode, construct, or interpret it.

page_size
integer
default:50

Maximum number of items to return per page. Values above 100 are clamped to 100 rather than rejected.

Required range: x >= 1

Response

Successful Response

users
UserWithCustomAttributes · object[]
required

Users returned in this page.

next_page_token
string | null

Token for the next page, or null when this is the last page. An absent token is the only end-of-results signal. A page holding fewer than page_size items does not mean the results are exhausted. Treat the value as opaque: do not decode, construct, or interpret it.