v2

latestOpenAPI 3.1.02026-07-2681948.3 KB
Users

Retrieve a list of users

Returns a paginated list of users in your organization with their profile, license, and integration status.

get/v1/users

Query parameters

pageNumberinteger

The page number to retrieve (1-based indexing). Defaults to 1 if not specified.

pageSizeinteger

The maximum number of users to return per page. Must be between 1 and 50. Defaults to 10 if not specified.

licenseAddedboolean

Filter users by license status. Use 'true' for licensed users, 'false' for unlicensed users.

role'VIEWER' | 'EDITOR' | 'ORGANIZATION_ADMIN' | 'USER_ADMIN' | 'USER'

Filter users by role.

Response

A paginated list of users.

pageCountinteger required

Total number of pages available for the current query.