SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

List my API keys

List metadata for keys owned by the current WorkspaceAPI actor. Raw secrets are never returned after creation or rotation.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1/workspaces/{workspace_id}

Authentication: bearer. Required scope: api_keys:read.

GET /api-keys

List metadata for keys owned by the current WorkspaceAPI actor. Raw secrets are never returned after creation or rotation.

Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/api-keys" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "items": [
    {
      "id": "key_01J8",
      "name": "Local integration",
      "prefix": "sym_ws_x7K2",
      "last_four": "9Qpf",
      "scopes": [
        "files:read",
        "chats:read"
      ],
      "last_used_at": "2026-08-04T10:30:00Z",
      "expires_at": null
    }
  ],
  "scopes": [
    "workspace:read",
    "api_keys:read"
  ],
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "api_keys:read",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
429The key exceeded its current rate limit.

Usage notes