Get Users

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

This endpoint requires Authorization.

Query Parameters

ParameterTypeDescriptionDefault
pageintegerPage number, starting at 1.1
per_pageintegerNumber of results per page. Min: 1, Max: 100.100

Response

Returns Paginated data where each item has the following fields:

KeyTypeDescription
idstringUnique identifier of the user (UUID).
namestringDisplay name of the user.
emailstringEmail address of the user.
group_namesarrayNames of the groups the user belongs to.
deactivated_atdatetimeTimestamp when the user was deactivated, or null if active.
created_atdatetimeTimestamp when the user was created.
📘

Note

Only active (non-deactivated) users are returned.

{
  "items": [
    {
      "id": "9e34b87d-79ca-4dc3-ac42-8ce9ebe8be82",
      "name": "Jane Doe",
      "email": "[email protected]",
      "group_names": ["administrators"],
      "deactivated_at": null,
      "created_at": "2024-01-15T10:00:00Z"
    }
  ],
  "next_page": null
}
Query Params
integer
Defaults to 1
integer
Defaults to 100
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json