---
title: "Online Agents"
method: GET
path: "/inbox/v1/user-presence/online-agents"
tags: ["Inbox"]
---

# Online Agents

`GET /inbox/v1/user-presence/online-agents`

## Request

- Base URL: `https://platform.hootsuite.com`
- URL: `https://platform.hootsuite.com/inbox/v1/user-presence/online-agents`
- Auth: OAuth 2
  - Authorization code: `https://platform.hootsuite.com/oauth2/auth`
  - Token URL: `https://platform.hootsuite.com/oauth2/token`

List of all currently online agents.

## Response `200`

Success

- OnlineAgentsResponse
  - `agents` object[]
    - `id` string, required
    - `userPresence` 'AWAY' | 'AVAILABLE', required
    - `awayStateId` string
    - `statusChangedAt` string, date-time, required

## Other responses

- `401`: Unauthorized: when using an invalid or expired access token.

---

[API](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api.md) - [All operations](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/revisions/adac53bd28bb?raw)