SautiDesk
SautiDesk API
Workspace configuration

List queues

GET
/v1/desk/queues

Lists the workspace's queues with the people in each, in the order set in Settings, 100 at a time. Each queue shows how it rings (order and duration) and, for every member, whether their phone is ringing now.

Requires: desk.read scope.

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

limit?integer

Page size: 100 by default, and 100 at most. A larger value is treated as 100.

cursor?string

next_cursor from the previous page. Leave it out for the first page.

Response

OK

Example

{  "data": [    {      "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37",      "name": "Amina Wanjiru",      "acd_name": "example",      "strategy": "example",      "ring_seconds": 60,      "wrap_seconds": 60,      "position": 1,      "members": [        {          "user_id": null,          "name": null,          "ring_to": null,          "provisioned_at": null,          "pending_reason": null,          "rings": null,          "not_ringing_reason": null        }      ]    }  ],  "next_cursor": "eyJvIjoyNX0",  "has_more": false}
FieldTypeDescription
datarequiredobject[]
idrequiredstring (uuid)
namerequiredstringA name for it.
acd_namerequiredstring
strategyrequiredstringHow calls are offered to the people in the queue, for example longest_free (the person free the longest), which is the default.
ring_secondsrequiredintegerHow long a call rings one person before it moves on.
wrap_secondsrequiredintegerHow long a person is left free of new calls after one ends, to write up.
positionrequiredintegerWhere it sits in the list, starting at 0.
membersrequiredobject[]The ids of the people in the queue.
user_idrequiredstring (uuid)The id of the person.
namerequiredstringA name for it.
ring_torequiredstringThe phone number this person's calls ring.
provisioned_atstring (date-time) | null
pending_reasonstring
ringsrequiredboolean
not_ringing_reasonstring
next_cursorrequiredstring | null
has_morerequiredboolean
curl -X GET "https://api.sautidesk.com/v1/desk/queues"