SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

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.

ParameterTypeDescription
agent_id
path · required
stringRequired agent_id path identifier.
Request
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"
Response 200
{
  "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

Credential contract
{
  "type": "bearer",
  "scope": "secrets:read",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.

Usage notes