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

Get the current actor

Resolve the user and workspace represented by this API key. Permissions are evaluated from current workspace membership on every request.

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 /me

Resolve the user and workspace represented by this API key. Permissions are evaluated from current workspace membership on every request.

Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/me" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "user": {
    "id": "user_example",
    "name": "Example User",
    "email": "developer@example.com"
  },
  "workspace": {
    "id": "workspace_example",
    "name": "Example Workspace"
  },
  "role": "owner",
  "key": {
    "id": "key_01J8",
    "name": "Local integration",
    "scopes": [
      "workspace:read",
      "agents:read",
      "chats:read"
    ]
  },
  "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.