Skip to main content
GET
Get a support ticket

Authorizations

X-API-Key
string
header
required

Path Parameters

ticket_id
string<shortuuid>
required

Ticket ID.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
subject
string
required

The ticket's one-line summary.

description
string
required

The opening message.

status
enum<string>
required

Where the ticket stands.

Available options:
open,
in_progress,
waiting_on_customer,
resolved,
closed
created
string
required

ISO 8601 timestamp.

modified
string
required

ISO 8601 timestamp of the last change.

messages
TicketMessageOut · object[]
required

The whole conversation, oldest first, starting with the opening message. Internal staff notes are never included.

category
string | null

Category slug, or null when none was chosen.

category_name
string | null

Category display name, or null when none was chosen.