List token scopes

curl --request GET \
  --url https://api.hq.zone/v1/api/tokens/scopes \
  --header 'Authorization: Bearer <token>'

[
  {
    "description": "<string>",
    "requires_admin": true,
    "scope": "<string>"
  }
]

GET

api

tokens

scopes

List token scopes

curl --request GET \
  --url https://api.hq.zone/v1/api/tokens/scopes \
  --header 'Authorization: Bearer <token>'

[
  {
    "description": "<string>",
    "requires_admin": true,
    "scope": "<string>"
  }
]

Authorization

string

header

required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

The resource:action scope vocabulary a token can be minted with

description

string

required

What granting it lets the token do (consent-screen phrasing).

requires_admin

boolean

required

True when minting this scope needs the admin role.

scope

string

required

The scope string to request, e.g. documents:read.

⌘I