SautiDesk
SautiDesk API
Team and licences

List pending team invitations

GET
/v1/desk/invitations

Lists the invitations in your workspace, pending ones first and 100 at a time, with who each is for and what role and licences it carries. Needs desk.admin.

Requires: desk.admin scope, workspace owner or admin.

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",      "email": "amina@example.com",      "name": "Amina Wanjiru",      "role": "agent",      "status": "open",      "product": "desk",      "invite_url": "https://example.com/file",      "licences": [        "converse"      ],      "expires_at": "2026-10-14T08:30:00Z",      "created_at": "2026-10-14T08:30:00Z",      "accepted_at": "2026-10-14T08:30:00Z",      "seat_billable": false,      "seat_billable_from": "2026-11-01",      "seat_note": "Billed from the next period",      "invited_by": "Wanjiku Mwangi",      "invited_via": "example"    }  ],  "next_cursor": "eyJvIjoyNX0",  "has_more": false}
FieldTypeDescription
datarequiredobject[]
idrequiredstring
emailrequiredstringAn email address.
namestringA name for it.
rolerequiredstringThe role: admin, agent or viewer.
statusrequiredstringThe status to set.
productrequiredstringdesk to invite the person to SautiDesk, or kit to invite them to SautiKit only.
invite_urlstring
licencesrequiredstring[]The Desk licences to give: converse (tickets and conversations), contacts (the address book) and supervisor (reports and listening in).
expires_atrequiredstring
created_atrequiredstring
accepted_atstring
seat_billablerequiredboolean
seat_billable_fromstring
seat_notestring
invited_bystring
invited_viastring
next_cursorrequiredstring | null
has_morerequiredboolean
curl -X GET "https://api.sautidesk.com/v1/desk/invitations"