List Docs

List all docs in a workspace.

GET/api/v1/docs

Authorization

apiKey
X-API-Key<token>

Your SteelEngine API key (personal or workspace). Generate one from the SteelEngine dashboard under Settings > API Keys.

In: header

Query Parameters

workspaceId*string

The unique identifier of the workspace.

folderId?string

Optional folder id. When provided, list only docs inside that folder. Omit to list across the whole workspace.

scope?string

Lifecycle scope filter. Defaults to active (live docs only).

Value in"active" | "archived" | "all"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET \  "https://steelengine.com/api/v1/docs?workspaceId=YOUR_WORKSPACE_ID" \  -H "X-API-Key: YOUR_API_KEY"
{
  "success": true,
  "data": {
    "files": [
      {
        "id": "file_abc123",
        "name": "data.csv",
        "size": 1024,
        "type": "text/csv",
        "key": "files/wsp_abc123/data.csv",
        "uploadedBy": "user_abc123",
        "uploadedAt": "2026-01-15T10:30:00Z"
      }
    ],
    "totalCount": 1
  }
}
{
  "error": "string",
  "details": [
    {}
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}