ListUsers
Retrieve and manage a comprehensive list of all users in your organization, including deactivated or unverified accounts, with customizable filtering, sorting, and pagination options.
Instructions
Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.
Query Parameters:
page[size]: Size for a given page. The maximum allowed value is 100.
page[number]: Specific page number to return.
sort: User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example
sort=-name. Options:name,modified_at,user_count.sort_dir: Direction of sort. Options:
asc,desc.filter: Filter all users by the given string. Defaults to no filtering.
filter[status]: Filter on status attribute. Comma separated list, with possible values
Active,Pending, andDisabled. Defaults to no filtering.
Responses:
200 (Success): OK
Content-Type:
application/jsonResponse Properties:
data: Array of returned users.
included: Array of objects related to the users.
Example:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}400: Bad Request
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}403: Authentication error
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}429: Too many requests
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Filter all users by the given string. Defaults to no filtering. | |
| filter[status] | No | Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. | |
| page[number] | No | Specific page number to return. | |
| page[size] | No | Size for a given page. The maximum allowed value is 100. | |
| sort | No | User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `modified_at`, `user_count`. | name |
| sort_dir | No | Direction of sort. | desc |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Array of returned users. | |
| meta | No | ||
| included | No | Array of objects related to the users. |