List Agent secret configuration
List configured environment-secret names and process-environment instructions for one accessible Agent. Secret values and broker-only storage paths are never returned. Workspace owner/admin permission is required.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: secrets:read.
GET /agents/{agent_id}/secrets
List configured environment-secret names and process-environment instructions for one accessible Agent. Secret values and broker-only storage paths are never returned. Workspace owner/admin permission is required.
| Parameter | Type | Description |
|---|---|---|
agent_idpath · required | string | Required agent_id path identifier. |
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/secrets" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"data": {
"profile_id": "agent_example",
"delivery": "process_environment",
"secrets": [
{
"name": "EXAMPLE_SERVICE_TOKEN",
"configured": true,
"reference": "EXAMPLE_SERVICE_TOKEN is available as an environment variable in Agent agent_example's runtime. Use the process environment; do not search for a file or print its value."
}
],
"configured_count": 1
},
"ok": true
}Authorization
{
"type": "bearer",
"scope": "secrets: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. |
| 404 | The resource is missing or intentionally hidden by authorization. |
| 429 | The key exceeded its current rate limit. |
Usage notes
- Values are write-only and never appear in reads, logs, audit events, webhooks, or this documentation.
- Both the secrets:read scope and current workspace owner/admin role are required.