Reports (Pro)
Agent availability at a moment
Returns who was available, on a call or away at one past moment. Give either at (an RFC 3339 time) or call_id, which uses the moment that call rang.
Requires: desk.supervise scope, Supervisor licence, Pro plan.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Query Parameters
at?string
A moment to look at, as a time (RFC 3339). Give this or call_id, not both.
call_id?string
The id of a call: looks at the moment that call rang. Give this or at, not both.
Response
OK
Example
{ "report": "service", "at": "2026-10-14T08:30:00Z", "timezone": "Africa/Nairobi", "call": { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "call_id": "5f8fdfd7-274f-478d-9141-184cd8996e3f", "ring_at": "2026-10-14T08:30:00Z", "direction": "inbound", "from": "+254712345678", "queue": "billing", "result": "example" }, "counts": { "example": 3 }, "agents": [ { "agent": { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "name": "Amina Wanjiru" }, "state": "available", "reason": "Outside business hours", "since": "2026-10-14T08:30:00Z", "seconds_in_state": 60 } ]}FieldTypeDescription
reportrequiredstringThe report to send, for example service or calls.atrequiredstring (date-time)timezonerequiredstringcallrequiredanyidrequiredstring (uuid)call_idrequiredstring (uuid) | nullThe id of the call this nudge is about, if any.ring_atrequiredstring (date-time)directionrequiredstringfromrequiredstringThe number or address to send from. It must belong to your workspace.queuerequiredstring | nullresultrequiredstringcountsrequiredobjectagentsrequiredobject[]agentrequiredobjectidrequiredstring (uuid)namerequiredstringA name for it.staterequiredstringThe availability to set: available, away, break, non_phone or offline.reasonrequiredstring | nullWhy, in a few words, for example Lunch.sincerequiredstring (date-time) | nullseconds_in_staterequiredinteger | nullcurl -X GET "https://api.sautidesk.com/v1/desk/reports/availability/at"