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

List available Agents

List only Agents the key owner can currently access. Staff-only and unassigned Agents are not disclosed.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: agents:read.

GET /agents

List only Agents the key owner can currently access. Staff-only and unassigned Agents are not disclosed.

ParameterTypeDescription
status
query
online | offline | creatingOptional status filter.
limit
query
integerPage size, maximum 100.
cursor
query
stringOpaque pagination cursor.
Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "items": [
    {
      "id": "agent_example",
      "name": "Example Agent",
      "status": "online",
      "can_message": true,
      "can_manage": true
    }
  ],
  "next_cursor": null,
  "ok": true
}

Authorization

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