v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBUsers
List all users
Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.
get/api/v2/users
Query parameters
page[size]integer
Example:10
Size for a given page. The maximum allowed value is 100.
page[number]integer
Specific page number to return.
sortstring
Example:name
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'asc' | 'desc'
Direction of sort.
Direction of sort. Options: asc, desc.
filterstring
Filter all users by the given string. Defaults to no filtering.
filter[status]string
Example:Active
Filter on status attribute. Comma separated list, with possible values Active, Pending, and Disabled. Defaults to no filtering.
Response
OK
Example response
{
"data": [
{
"relationships": {
"org": {
"data": {
"id": "00000000-0000-beef-0000-000000000000",
"type": "orgs"
}
},
"other_orgs": {
"data": []
},
"other_users": {
"data": []
},
"roles": {
"data": [
{
"id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
"type": "roles"
}
]
}
},
"type": "users"
}
],
"included": [
{
"type": "orgs"
}
]
}