Skip to main content
GET
Get Users

Authorizations

Authorization
string
header
required

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

Query Parameters

search_term
string | null

Search for users by name or email.

exact_match
boolean
default:false

If a search_term is provided, only accept exact matches.

expand
string[] | null

Fields to expand. Supported fields: custom_attributes.

page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

items
UserWithCustomAttributes · object[]
required
total
integer | null
required
Required range: x >= 0
page
integer | null
required
Required range: x >= 1
size
integer | null
required
Required range: x >= 1
pages
integer | null
Required range: x >= 0