v1

latestOpenAPI 3.0.02026-07-26870415.2 KB
tickets

Search tickets

Find tickets by contact identity, subject, channel value, or message body. This search spans all statuses unless you provide a status filter.

get/v1/tickets/search

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o
querystring required

Search value. Ticket metadata search covers subject, contact identity, and supported channel values. Use field=message to search message body text.

Example:joe@gmail.com
field'any' | 'contact' | 'subject' | 'channel' | 'message'

Search scope. subject restricts to the ticket subject, contact restricts to the linked contact identity, channel restricts to contact channel values, and message searches ticket transcripts.

Example:contact
limitinteger
cursorstring
status'open' | 'new' | 'pending' | 'resolved' | 'closed'

Optional ticket status filter. open searches actionable tickets (new + pending).

inbox_type_idstring
waiting_on'team' | 'customer' | 'third_party' | 'none'
channelstring

Response

Ticket search results

next_cursorstring nullable required
has_moreboolean required

Example response

{
  "data": [
    {
      "id": "xd88mkfbmxgckpeyzs8m9r9d3d843me3",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "contact_id": "ph77c0dy0mgdpzmqz6tesry8w184002s",
      "conversation_id": "ph77c0dy0mgdpzmqz6tesry8w184002s",
      "channel": "unthreaded_email",
      "status": "new",
      "waiting_on": "customer",
      "inbox_type_id": "guest",
      "subject": "Early check-in request",
      "summary": "Guest asked to confirm whether early arrival is possible.",
      "ai_paused": false,
      "assignee": {
        "id": "m48k3v7p2q9x5t1w8r6n4j0y3u2i5o7a",
        "name": "Alex M",
        "email": "alex@example.com",
        "picture_url": null
      },
      "follow_up_at": null,
      "last_message_at": "2026-04-03T03:14:15.000Z",
      "last_message_preview": "Can I check in early?",
      "created_at": "2026-04-01T17:22:10.000Z",
      "updated_at": "2026-04-03T03:14:15.000Z",
      "call_transcript_id": null
    }
  ],
  "next_cursor": "page-token",
  "has_more": true
}