Skip to main content

Retrieve a ticket

Fetches a single ticket by its ticket ID, scoped to the bot given in bot. The full ticket document is returned under ticket — the same shape as the objects in the search and view listings, with no field filtering applied. A ticket ID that doesn't exist on that bot returns 404; a ticket belonging to a different bot is not visible.

Path Parameters
id string — REQUIRED

The ticket ID.

Query Parameters
bot string — REQUIRED

The unique ID of the bot.

Responses
200

Ticket found.

Schema — OPTIONAL
ticket object — OPTIONAL
400

Missing ticket ID or bot.

Schema — OPTIONAL
error string — OPTIONAL

Human-readable error message.

401

Missing/invalid API key.

Schema — OPTIONAL
error string — OPTIONAL

Human-readable error message.

404

Ticket not found on this bot.

Schema — OPTIONAL
error string — OPTIONAL

Human-readable error message.

429

Rate limit exceeded.

Schema — OPTIONAL
error string — OPTIONAL

Human-readable error message.

500

Internal server error.

Schema — OPTIONAL
error string — OPTIONAL

Human-readable error message.