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.
| Parameter | Type | Description |
|---|---|---|
statusquery | online | offline | creating | Optional status filter. |
limitquery | integer | Page size, maximum 100. |
cursorquery | string | Opaque pagination cursor. |
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"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
{
"type": "bearer",
"scope": "agents:read",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 401 | The workspace API key is missing, invalid, expired, or revoked. |
| 403 | The key lacks the required scope or its owner no longer has permission. |
| 429 | The key exceeded its current rate limit. |