> For the complete documentation index, see [llms.txt](https://documentation.proto.cx/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.proto.cx/docs/developers/apis/users-api.md).

# Users API

Read which users held a given [status](/docs/settings/user-account/online-status.md) over a period.

***

### [**List users by status**](https://v3-api.proto.cx/api/platform/v1/docs#/v1/list_users_by_status_v1_users__subcompany_id___start_datetime___end_datetime__users_by_status_get)

Lists users whose [status](/docs/settings/user-account/online-status.md) matched the given values during the period. Use this to report on live agent availability.

{% code title="URL" overflow="wrap" %}

```
GET https://v3-api.proto.cx/api/platform/v1/users/{subcompany_id}/{start_datetime}/{end_datetime}/users-by-status
```

{% endcode %}

**Query parameters**

| Parameter  | Required | Type   |
| ---------- | -------- | ------ |
| `statuses` | No       | string |

{% code title="Returns" overflow="wrap" %}

```
{
  "data": [object]
}
```

{% endcode %}