v1
latestOpenAPI 3.1.02026-08-04147764567.0 KBusers
Get paginated users list
get/api/v1/users/list
Query parameters
search_keystring
pageinteger required
per_pageinteger
sort_order'CREATED_AT_DESC' | 'CREATED_AT_ASC' | 'UPDATED_AT_DESC' | 'UPDATED_AT_ASC' | 'NAME_EMAIL_ASC' | 'NAME_EMAIL_DESC'
is_deletedboolean
has_slackboolean
rolestring
role_idinteger
user_status'ACTIVE' | 'INACTIVE' | 'ALL'
invitation_status'ADDED' | 'EMAIL_INVITE_SENT' | 'ACCEPTED'
typesApiV1UsersListGetParametersTypesSchemaItems[]
Optional comma-separated list of user types to filter by
expandApiV1UsersListGetParametersExpandSchemaItems[]
excluded_user_idsinteger[]
notification_enabledboolean
Filter users by notification enabled status
employee_idstring
Filter users by employee ID (exact match)
Headers
X-Api-Keystring required
X-Workspace-Idstring
Response
Successful response
UsersGetapiV1UsersListResponse200 required
Empty response body