List all users
GET {{baseUrl}}/api/v2/users?page[size]=10&page[number]=0&sort=name&sort_dir=desc&filter=<string>&filter[status]=<string>
Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page[size] | number | Size for a given page. The maximum allowed value is 100. | |
page[number] | number | Specific page number to return. | |
sort | string | 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 | string | Direction of sort. Options: asc, desc. | |
filter | string | Filter all users by the given string. Defaults to no filtering. | |
filter[status] | string | Filter on status attribute. | |
Comma separated list, with possible values Active, Pending, and Disabled. | |||
| Defaults to no filtering. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"}],"included":[{"type":"orgs","attributes":{"created_at":"\u003cdateTime\u003e","description":"\u003cstring\u003e","disabled":"\u003cboolean\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","public_id":"\u003cstring\u003e","sharing":"\u003cstring\u003e","url":"\u003cstring\u003e"},"id":"\u003cstring\u003e"},{"type":"orgs","attributes":{"created_at":"\u003cdateTime\u003e","description":"\u003cstring\u003e","disabled":"\u003cboolean\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","public_id":"\u003cstring\u003e","sharing":"\u003cstring\u003e","url":"\u003cstring\u003e"},"id":"\u003cstring\u003e"}],"meta":{"page":{"total_count":"\u003clong\u003e","total_filtered_count":"\u003clong\u003e"}}}