SautiDesk
SautiDesk API
Workspace configuration

List call and ticket outcomes

GET
/v1/desk/outcomes

Lists the workspace's outcomes. Use kind=call (the default) for the choices an agent picks when wrapping up a call, or kind=ticket for the choices offered when resolving a ticket.

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

kind?string

call (the default) for call outcomes, or ticket for ticket outcomes.

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",      "name": "Amina Wanjiru",      "effect": "example",      "requires_note": false,      "position": 1    }  ],  "next_cursor": "eyJvIjoyNX0",  "has_more": false}
FieldTypeDescription
datarequiredobject[]
idrequiredstring (uuid)
namerequiredstringA name for it.
effectrequiredstringWhat closing the call does to the ticket, as the outcome's settings define.
requires_noterequiredbooleanTrue if the person must write a note before they can choose this outcome.
positionrequiredintegerWhere it sits in the list, starting at 0.
next_cursorrequiredstring | null
has_morerequiredboolean
curl -X GET "https://api.sautidesk.com/v1/desk/outcomes"