Skip to content

Get an API token

GET
/api/api-tokens/{id}

Returns a single API token by ID. The authenticated user must be the token owner (VIEW). Only metadata is returned (name, expiration, last-used timestamp, active state, organization scopes); the secret token value is never disclosed after creation.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

id*

api-token identifier

Type
string
Required

Responses

api-token resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  
"name": "CI deployment token",
  
"lastUsedAt": "2026-06-30T14:23:00+00:00",
  
"expiresAt": "2027-06-30T00:00:00+00:00",
  
"active": true,
  
"createdAt": "2026-06-30T09:00:00+00:00",
  
"organizations": [
  
  
[
  
  
  
"/api/organizations/12",
  
  
  
"/api/organizations/34"
  
  
]
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI