SautiDesk
SautiDesk API
Contacts

Search tickets and contacts

GET
/v1/desk/search

Searches tickets and contacts at once by name, number, email or reference, returning only what the key's person may see. q is required, and category, outcome, status, owner and limit narrow the ticket results.

Requires: desk.read scope, Converse or Contacts 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

q*string

The words to look for.

category?string

Only tickets in this category, by name.

outcome?string

Only tickets with this outcome, by name.

status?string

Only tickets with this status: open or resolved.

owner?string

Only tickets owned by this person: their id (a UUID).

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": [    {      "kind": "billing",      "contact_id": "e370603e-5791-443e-9fb1-26dedb014cd9",      "contact_name": "Amina Wanjiru",      "contact_number": "+254712345678",      "contact_email": "amina@example.com",      "ticket_ref": "TCK-4471",      "ticket_subject": "Order 1182 has not arrived",      "status": "open",      "category": "billing",      "outcome": "billing",      "snippet": "Hi Amina, your order has shipped.",      "when": "2026-10-14T08:30:00Z",      "activity_id": "0d6c4f09-7095-4291-9bdb-50991c39602c",      "author_kind": "agent",      "author_name": "Wanjiku Mwangi",      "author_user_id": "cacbaaf9-2b98-46a1-9b0e-04f92c823408",      "author_note": false    }  ],  "next_cursor": "eyJvIjoyNX0",  "has_more": false,  "capped": false}
FieldTypeDescription
datarequiredobject[]
kindrequiredstringWhat kind it is.
contact_idrequiredstring (uuid)The id of the contact the task is about.
contact_namerequiredstring
contact_numberstring
contact_emailstring
ticket_refstring
ticket_subjectstring
statusstringThe status to set.
categorystringThe name of the category.
outcomestringHow it ended: the name or id of one of your outcomes.
snippetstring
whenstring (date-time) | null
activity_idstringThe id of the message on the ticket to forward.
author_kindstring
author_namestring
author_user_idstring
author_noteboolean
next_cursorrequiredstring | null
has_morerequiredboolean
cappedrequiredboolean
curl -X GET "https://api.sautidesk.com/v1/desk/search?q=string"