Get the WorkspaceAPI root
Confirm the selected workspace API version and discover its documentation route.
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 /
Confirm the selected workspace API version and discover its documentation route.
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"version": "v1",
"workspace_id": "workspace_example",
"docs": "/docs",
"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. |