Users

List users.

Changed on Oct 10, 2026

Lists users sorted by username, including deactivated users, with the total count. Requires an administrator as well as the scope. Requires the users:read scope.

get/api/users

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
URL
/api/users
Auth
HTTP bearer

Query parameters

qstring

rolestring

activeboolean

sortstring

orderstring

offsetinteger

limitinteger

Headers

Authorizationstring required

Response

A page of users.

totalinteger

Changes

Oct 10, 2026c4f85daa9208 Revision changes
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Oct 10, 20261e983a7188bf Revision changes
- info
  added the new optional query request parameter active
- info
  added the new optional query request parameter order
- info
  added the new optional query request parameter q
- info
  added the new optional query request parameter role
- info
  added the new optional query request parameter sort

Operation history (7 revisions)