API Reference
The Ticket Tool REST API lets your own applications manage tickets, categories, panels, flows, automation rules, custom commands, the knowledge base and canned replies, read analytics, and receive webhooks.
Pro and organization plans
API access starts on the Pro server plan and is included on the Team and Enterprise organization plans. A test server with 5 or fewer members can use it free with a developer license, with fewer tokens and a lower request limit than Pro. Authentication shows where to create a token.
Base URL
https://api.ticket-tool.app/v1
Every request is authenticated with a bearer token:
Authorization: Bearer tt_...
Two kinds of token
Guild token (Pro)
Works with one server. Call endpoints directly: GET /v1/tickets
returns that server's tickets.
Organization token (Team & Enterprise)
Works across your whole organization. Reach any member server at
/v1/org/servers/{guildId}/…, and read combined stats
under /v1/org.
Resources
Each resource name opens its endpoints in the API explorer.
| Resource | What you can do |
|---|---|
| Tickets | List, create, update, close, claim and reply to tickets, manage participants, read transcripts |
| Categories | Create, read, update and delete ticket categories |
| Panels | Create, edit and deploy ticket panels |
| Flows | Manage support flows |
| Automation rules | Manage triggers, conditions and actions. Uses the flows scopes |
| Custom commands | Commands that open a ticket or start a flow. Uses the flows scopes |
| Knowledge base | Manage knowledge base articles |
| Canned replies | The snippets staff send with /canned. Uses the knowledgebase scopes |
| Analytics | Overview, daily snapshots, team performance and CSAT |
| Webhooks | Register endpoints and read delivery history. See Webhooks |
Interactive reference
API Explorer
Browse and try every endpoint interactively
OpenAPI spec
Machine-readable 3.1 spec for SDKs and Postman/Insomnia