Count Users
GET {{baseUrl}}/api/v2/users/count?role=<string>&role[]=<string>&permission_set=<integer>
Returns an approximate count of users. If the count exceeds 100,000, it is updated every 24 hours.
The response includes a refreshed_at
property in a count
object that contains a timestamp indicating when the count was last updated.
Note: When the count exceeds 100,000, the refreshed_at
property may occasionally be null.
This indicates that the count is being updated in the background. The count
object's value
property is limited to 100,000 until the update is complete.
Allowed For
- Admins, Agents and Light Agents
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
role | string | Filters the results by role. Possible values are "end-user", "agent", or "admin" | |
role[] | string | Filters the results by more than one role using the format role[]={role}&role[]={role} | |
permission_set | string | For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":{"refreshed_at":"2020-04-06T02:18:17Z","value":102}}