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

Quickstart

Make your first read-only request to an existing workspace.

API 2.7.0 · Published service contract ↗

  1. Choose your workspace

    Sign in to Sym and open the workspace you can access. Copy its workspace ID; a workspace name is not an API identifier.

  2. Create a scoped API key

    Use the workspace API-key controls to create a key with agents:read. Keep it on your server, not in frontend JavaScript.

  3. List available Agents

    Set WORKSPACE_ID and SYM_WORKSPACE_API_KEY in your local environment, then run the example below.

Your first request

List Agents you can access
curl --fail-with-body "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents?limit=20" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"

The response lists only Agents you can currently access. Workspace membership, Agent access and key scopes are checked on every operation.

Next steps

List Agents

Parameters, returned fields and error responses.