Skip to main content
GET
List raw availability events (paginated)

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