Documentation

Learn TicketsX faster

Setup guides, the full command reference, Premium features, and the REST API in one place.

Get a Transcript

GET/<guild_id>/api/transcripts/<ticket_id>

Fetch a closed ticket’s entire transcript by ticket ID: the full metadata (author, panel, rating, close reason, claimers, timestamps), every message in chronological order, and per-participant message stats. Find the ticket first with **Search Transcripts**, or fetch the rendered archive with **Get Transcript HTML**. Requires the `view_transcripts` permission (off by default).

Query Parameters

NameTypeRequiredDescription
limitnumberoptionalMessages per page, 1–1000 (default 500).
offsetnumberoptionalNumber of messages to skip for pagination (default 0).

The messages and participants content comes from the transcript index, which is built while your server has Premium and backfilled across your existing archive when you first upgrade. A ticket that closed before the upgrade (or while a backfill is still running) comes back with indexed: false and an empty messages array — fetch Get Transcript HTML or transcript.TranscriptUrl for those. Use the pagination object to page through long tickets.

Example request
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  "https://api.ticketsx.xyz/<guild_id>/api/transcripts/<ticket_id>?limit=500"
Example response
{
  "transcript": {
    "TicketId": 42,
    "PanelId": 1,
    "PanelName": "Support",
    "AuthorId": "123456789",
    "AuthorUsername": "jane",
    "Rating": 5,
    "CloseReason": "Resolved",
    "CreatedAt": 1732200000,
    "ClosedAt": 1732210000,
    "ClosedBy": "987654321",
    "ClaimedIds": ["987654321"],
    "TranscriptUrl": "https://tickets.example.com/<guild_id>/transcripts/42"
  },
  "indexed": true,
  "messages": [
    { "MessageId": "111", "AuthorId": "123456789", "AuthorUsername": "jane", "IsBot": false, "Content": "My login is broken", "CreatedAt": 1732200050 },
    { "MessageId": "112", "AuthorId": "987654321", "AuthorUsername": "staff", "IsBot": false, "Content": "Looking into it now!", "CreatedAt": 1732200110 }
  ],
  "participants": [
    { "UserId": "123456789", "Username": "jane", "IsBot": false, "MessageCount": 12, "FirstMessageAt": 1732200050, "LastMessageAt": 1732209900 }
  ],
  "pagination": { "total": 2, "limit": 500, "offset": 0, "returned": 2 }
}