API ReferenceUser Management

List Users

List users in the organization. This endpoint retrieves a paginated list of users in the organization. The response can be filtered by a search query and optionally include user roles.

Headers

AuthorizationstringRequired

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

Query parameters

querystringOptionalformat: "^[a-zA-Z0-9@._\-\s*?]+$">=3 characters<=50 characters
Search query to match names and emails
offsetintegerOptional>=0Defaults to 0

Number of records to skip (for pagination)

limitintegerOptional>=1<=100Defaults to 100
Number of users to return
include_rolesbooleanOptionalDefaults to false
Include user roles in the response

Response

A paginated list of users in the organization
userslist of objects
List of users with partial information
metaobject
Pagination metadata for the response

Errors