---
title: "Agent availability"
method: POST
path: "/inbox/v1/user-presence/metrics/agent-availability"
tags: ["Inbox"]
---

# Agent availability

`POST /inbox/v1/user-presence/metrics/agent-availability`

## Request

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

The number of agents available or away. You can filter by teams.

## Request body

- AgentAvailabilityRequest
  - `teamIds` string[]: Filter by teams
  - `userPresenceStatus` 'AWAY' | 'AVAILABLE'

## Response `200`

Success

- NumberMetricResponse
  - `value` integer

## 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)