Skip to main content

Authentication

Every API request carries a bearer token. Tokens belong either to one server or to a whole organization, and each one only does what its scopes allow. The base URL is https://api.ticket-tool.app/v1.

Pro and organization plans

API tokens are available on the Pro server plan and on the Team and Enterprise organization plans. A test server with 5 or fewer members can also create them with a developer license, with fewer tokens and a lower request limit than Pro. Free and Community servers otherwise cannot.

Creating an API token

Guild token

In the server dashboard, open Settings & Access → API & Webhooks and stay on the API tab.

Organization token

Open Organization Settings → Automation and use Organization API Tokens.

When you create a token, you can:

Name the token

Give it a name so you can identify it later.

Select scopes

Select the scopes it is allowed to use (for example tickets:read, tickets:write, or org:analytics:read).

Set an expiry (optional)

Set an optional expiry date, or leave it with no expiry.

Copy it once

The token value is shown only once at creation time, so copy it and store it somewhere safe right away. The dashboard keeps a short prefix and the token's metadata, but it cannot show you the full value again.

Using a token in requests

Tokens look like tt_... and are sent in the Authorization header as a Bearer token:

Authorization: Bearer tt_...

A guild token is bound to one server, so resource paths are direct (GET /v1/tickets). An organization token reaches any member server by prefixing a guild path with /org/servers/{guildId} (for example GET /v1/org/servers/{guildId}/tickets) and has cross-server reporting under /v1/org.

Token and rate limits

How many active tokens you can hold, and how many requests each token can make per minute, depend on your plan. The API tab shows both for your server: tokens used out of your allowance, and the per-minute limit. Creating a token past the allowance is refused with the limit in the error. See Rate limits for what happens when a token goes over.

Managing and revoking tokens

You can view your active tokens and revoke any token at any time from the same place you created it. Revoking a token takes effect immediately, so generate a replacement before retiring one that is still in use.

Next steps