Get workspace instructions
Read workspace instruction markdown and safe effective-layer metadata.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: instructions:read.
GET /workspace/instructions
Read workspace instruction markdown and safe effective-layer metadata.
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/workspace/instructions" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"item": {
"scope_type": "workspace",
"scope_id": "workspace_example",
"markdown": "Use workspace evidence and cite durable resources.",
"revision": 7,
"content_hash": "b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef01",
"can_manage": true,
"applies_to": "new_conversations"
},
"constitution": {
"version": "1",
"content_hash": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
"managed": true
},
"effective_order": [
{
"layer": "platform_foundation",
"managed": true
},
{
"layer": "workspace_instructions",
"managed": false,
"revision": 7
},
{
"layer": "profile_identity",
"managed": false
}
],
"ok": true
}Authorization
{
"type": "bearer",
"scope": "instructions: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. |