List Docs

List all docs in a workspace.

GET/api/v1/docs
X-API-Key<token>

Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization 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"
limit?integer

Page size (1-200). Omit both limit and cursor to receive every doc in one response; when only cursor is sent the page size defaults to 100.

Range1 <= value <= 200
cursor?string

Pagination cursor returned in a previous response's nextCursor field.

Response Body

application/json

application/json

application/json

application/json

application/json

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