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

List files and folders

Browse an Agent's project-files tree using paths relative to its guarded root.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1/workspaces/{workspace_id}

Authentication: bearer. Required scope: files:read.

GET /agents/{agent_id}/files

Browse an Agent's project-files tree using paths relative to its guarded root.

ParameterTypeDescription
agent_id
path · required
stringAuthorized Agent ID.
path
query
stringRelative folder path; empty means root.
Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/files" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "path": "reports",
  "items": [
    {
      "name": "august",
      "path": "reports/august",
      "type": "folder",
      "modified_at": "2026-08-04T09:00:00Z"
    },
    {
      "name": "summary.md",
      "path": "reports/summary.md",
      "type": "file",
      "size": 8421,
      "mime_type": "text/markdown"
    }
  ],
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "files: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.