Documentation

Learn TicketsX faster

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

Authentication

API tokens are created and managed from the server sidebar in the TicketsX dashboard. Each token is tied to a single guild, and the server needs an active Premium subscription to create or use one.

Creating a Token


  • Activate Premium for the server from the Premium page (the API Access page links straight to it).
  • Open the server sidebar and go to API Access.
  • Name the token (e.g., "Support Bot" or "CRM Sync").
  • Click Create Token and copy the value shown.
  • Store it in a secret store; you cannot view it again after closing the banner.

If Premium Lapses


Your tokens are not deleted. Every API request starts returning 402 with premium_required: true, and creating or rotating tokens is blocked, until the subscription is active again. Listing, disabling, and revoking tokens keeps working so you can clean up regardless. Handle 402 in your integration the same way you handle 401: stop retrying and alert a human.

Response when the server has no Premium
{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

Revoking a token immediately invalidates it for all endpoints. Create a replacement first if you need zero downtime.

Using a Token


Send the token as a Bearer header on every request. All requests are scoped to the guild that created the token.

Example authenticated request
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets