Get compact workspace overview
Return small authorization-filtered counts for Agents, chats, and operations without listing resource payloads.
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 /overview
Return small authorization-filtered counts for Agents, chats, and operations without listing resource payloads.
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/overview" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"workspace": {
"id": "workspace_example"
},
"generated_at": "2026-08-06T14:20:00Z",
"agents": {
"authorized": 4,
"online": 3,
"responding": 1
},
"chats": {
"active": 12,
"unread": 2
},
"operations": {
"running": 1,
"failed": 0
},
"ok": true
}Authorization
{
"type": "bearer",
"scope": "workspace: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. |