SautiDesk
SautiDesk API
Channels and templates

List support email addresses

GET
/v1/desk/mail/addresses

Lists the email addresses the desk sends and receives on, with the queue each one feeds. Mail sent to these addresses becomes tickets.

Requires: desk.read scope, Converse licence.

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

cursor?string

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

limit?integer

Page size: 100 by default, 100 at most.

Response

OK

Example

{  "data": [    {      "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37",      "address": "help@support.example.com",      "name": "Amina Wanjiru",      "domain": "support.example.com",      "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40",      "queue_name": "Support",      "sends": false    }  ],  "next_cursor": "eyJvIjoyNX0",  "has_more": false}
FieldTypeDescription
datarequiredobject[]
idrequiredstring (uuid)
addressrequiredstringAn email address.
namerequiredstringA name for it.
domainrequiredstringThe domain you send and receive email on, for example support.example.co.ke.
queue_idrequiredstringThe id of the queue that receives what arrives here.
queue_namerequiredstring
sendsrequiredboolean
next_cursorrequiredstring | null
has_morerequiredboolean
curl -X GET "https://api.sautidesk.com/v1/desk/mail/addresses"