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

limit
integer | null
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

offset
integer | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

query
string | null

Filter users by email substring match.

Example:

"john@example.com"

showInvalidUsers
boolean | null
default:false

When true, includes deactivated users in the response.

Response

200 - application/json

Paginated list of users the caller has access to.

data
User · object[]
required

Array of users matching the query.

pagination
Pagination · object
required

Pagination metadata.