---
title: "Count Users"
method: GET
path: "/api/v2/users/count"
tags: ["Users"]
---

# Count Users

`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

## Query parameters

- `role` 'end-user' | 'agent' | 'admin'
- `role[]` string
- `permission_set` integer

## Response `200`

Success response

- CountResponse
  - `count` object
    - `refreshed_at` string, datetime
    - `value` integer

---

[API](https://skmtc.net/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.net/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/botbrains-io/support-api/versions/d53eac07ba68/schema)