Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/workspaces/{id}/api-tokens` — list the workspace's tokens (newest first, revoked included; never a plaintext).

GET
/api/workspaces/{id}/api-tokens
curl --request GET \
  --url https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/api-tokens \
  --cookie supacloud_session=<supacloud_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Workspace ID

Responses

Section titled “Responses”

200

Section titled “200”

The workspace’s API tokens

Media typeapplication/json
Array<object>

One workspace API token. token (the scmt_ plaintext) is present ONLY on the mint response — a list never carries it.

object
created_at
required
string format: date-time
expires_at
string | null format: date-time
fingerprint
required

The public correlation handle (also the revoke path parameter).

string
id
required
string format: uuid
label
required
string
last_used_at
string | null format: date-time
revoked_at
string | null format: date-time
scopes
required
Array<string>
token

The plaintext bearer — mint response only, shown exactly once.

string | null
Examplegenerated
[
  {
    "created_at": "2026-04-15T12:00:00Z",
    "expires_at": "2026-04-15T12:00:00Z",
    "fingerprint": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "label": "example",
    "last_used_at": "2026-04-15T12:00:00Z",
    "revoked_at": "2026-04-15T12:00:00Z",
    "scopes": [
      "example"
    ],
    "token": "example"
  }
]

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}