Skip to content
Open Console →

API keys

3 endpoints under /api/v1/tokens.

GET /api/v1/tokens #

List your API tokens (with their org bindings)

Responses

200 Your tokens.
Response body
  • tokensPersonalToken[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • startstringrequired
    • enabledbooleanrequired
    • createdAtstring · date-timerequired
    • expiresAtstring · date-timerequired
    • lastRequeststring · date-timerequired
    • orgSlugstringrequired
    • scopeobject[]required
      Show fields
      • rolestringrequired
      • roleNamestringrequired
      • resourceIdsstring[]required
401 Unauthenticated.
Response body
  • errorstringrequired
POST /api/v1/tokens #

Mint an API token, bound to your acting organization

Request body

  • namestringrequired
  • expiresIninteger
  • scopeobject[]
    Show fields
    • rolestringrequired
    • resourceIdsstring[]

Responses

201 The token — shown once, store it safely.
Response body
  • idstringrequired
  • keystringrequired
  • orgSlugstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
GET /api/v1/tokens/scope-options #

Roles and resources your own token may be narrowed to

Responses

200 Grantable roles (built-in + your org's custom roles) and the resources YOU can read — a token scope can never name more than its owner can see.
Response body
  • rolesTokenScopeRole[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • descriptionstringrequired
    • scopablebooleanrequired
    • servicestring
  • resourcesTokenScopeResource[]required
    Show fields
    • servicestringrequired
    • idstringrequired
    • namestringrequired
401 Unauthenticated.
Response body
  • errorstringrequired