GET/v1/workspace/api-keys

Read workspace api-keys

Every API key the workspace has minted across all its boards and pages in one place — each key's name, prefix, scopes, last use and revocation, never a secret — plus the scopes an admin may mint and the boards and pages a key can be pointed at. ADMIN AND ENTERPRISE only: a member of a lesser plan hears 403 for the seat before the plan is even considered. A board's own key routes are not gated this way.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

bodyquery · nulloptional

paramsquery · objectoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "keys": [
      {
        "boardId": "",
        "createdAt": "string",
        "definitionKey": "string",
        "id": "",
        "keyPrefix": "string",
        "lastUsedAt": "string",
        "memberEmail": "string",
        "name": "string",
        "rotatedAt": "string",
        "scopes": [
          "string"
        ],
        "targetLabel": "string"
      }
    ],
    "scopes": [
      "string"
    ],
    "targets": [
      {
        "id": "",
        "kind": "string",
        "label": "string"
      }
    ]
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired