Permissions
Which permissions a key can carry, and ready-made sets.
A key's permissions are the same ones your role has in the dashboard. When you create a key you choose a subset of the permissions you hold, in the experiences you choose.
| Permission | What it allows through the API |
|---|---|
players.lookup | Look up a player, list running servers |
stats.view | Read a player's tracked stats (Datastores) |
moderation.view_history | Read moderation records |
moderation.warn | Warn players and add notes |
moderation.kick | Kick players |
moderation.ban | Ban players |
moderation.unban | Lift bans |
game.announce | Announce in every running server |
analytics.view | Read analytics |
staff.view | List staff and roles, and read sessions and shifts (Sessions module) |
audit.view | Read the audit log |
tickets.view | Read tickets and their messages |
tickets.respond | Reply to tickets, add staff notes, close and reopen |
moderation.appeals | Read and decide ban appeals (accepting also needs moderation.unban) |
moderation.watchlist | Add and remove players on the watchlist |
forms.view | Read forms and their responses |
records.view | Read staff records of staff below the key's role (Staff records module) |
activity.view_all | Read the staff activity board; needs staff.view too (Activity module) |
timeoff.review | Read time off requests waiting for a decision and who is away (Time off module) |
assignments.manage | Read assignments and everyone's progress (Assignments module) |
promotions.vote | Read promotion recommendations and votes (Promotions module) |
orders.view | Read orders; needs orders.log too (Orders module) |
webhooks.manage | Add, change and delete webhooks, and read their deliveries. Sensitive: a webhook sends the experience's events to an address you choose |
Other permissions are not available to keys yet.
Ready-made sets
- Read only: look up players, read moderation history, analytics and staff.
- Moderation bot: everything read-only, plus warn, kick, ban and unban.
- Announcer: send in-game announcements.
- Support desk: read and answer tickets, review ban appeals.
- Integration builder: manage webhooks and read the audit log.
- Audit export: read the audit log.
Plans
The API is part of every plan. Endpoints that use a paid feature need that feature on the experience owner's plan, like in the dashboard: moderation endpoints need Moderation, analytics needs Analytics, the audit log needs Audit logs, announcements need the In-game integration, and staff records, orders and activity need Staff management (Plus or Pro) with their module switched on.
A key is never treated as the owner, even when the owner made it: it can only do what its permissions say.
Requests per minute depend on the plan of the person who created the key.