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

Get the workspace

Return the workspace bound to the key, including capabilities currently available to its owning user.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: workspace:read.

GET /workspace

Return the workspace bound to the key, including capabilities currently available to its owning user.

Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/workspace" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "workspace": {
    "id": "workspace_example",
    "name": "Example Workspace",
    "handle": "example",
    "capabilities": [
      "agents.create",
      "files.write",
      "messages.send"
    ]
  },
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "workspace: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.