GET /api/v2/users/count

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

Servers

https://{subdomain}.{domain}.com

Query parameters

Name	Type	Required	Description
`brand_id`		No	When brand separation is enabled, scopes the count to users belonging to the specified brand. Only applicable when the account has brand separation enabled. Accepted values: "all" — count all users across all brands (no brand filtering applied). 0 — count only account-scoped (brand-less) users. A numeric brand id — if the brand has user separation enabled, count end users belonging to that brand plus all agents and admins (who are account-level and always included). If the brand does not have user separation enabled, the request falls back to account scope (0).
`role[][]`	Array	No	Filters the results by more than one role using the format `role[]={role}&role[]={role}`
`permission_set`	Integer	No	For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request
`role`	String	No	Filters the results by role. Possible values are "end-user", "agent", "admin", or a custom role name

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.