Skip to main content
GET
/
api
/
escalation-dashboard
/
availability-events
List raw availability events (paginated)
curl --request GET \
  --url https://your-instance.example.com/api/escalation-dashboard/availability-events \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "events": [
      {
        "_id": "7b2c4e0d9f1a3b4e5c6d7e8f9012",
        "userId": "5f7b1c2e8a1d4e0012c3b4a5",
        "userName": "Sam Patel",
        "category": "availability",
        "value": "available",
        "source": "toggle",
        "occurredAt": "2026-05-18T14:31:02.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 143,
      "totalPages": 3
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

departmentId
string

Optional department filter. ADMIN/SUPERADMIN may pass any departmentId; DEPARTMENT_HEAD is implicitly scoped to their own department and any other value is ignored.

userId
string
start
string<date-time>

ISO-8601 start of the window. Defaults to end - 24h.

end
string<date-time>

ISO-8601 end of the window. Defaults to now.

page
integer
default:1

1-based page number.

Required range: x >= 1
limit
integer
default:50

Page size. Clamped to [1, 200].

Required range: 1 <= x <= 200
category
enum<string>
Available options:
connection,
availability,
capacity
value
enum<string>
Available options:
online,
offline,
available,
unavailable,
at_capacity,
has_capacity
source
enum<string>
Available options:
socket,
toggle,
auto_away,
assignment,
resolution,
system

Response

Availability events returned

success
enum<boolean>
required
Available options:
true
data
object
required