Sign in
Documents

List documents

Returns up to 100 documents per page. Use filters to narrow the results.

get/documents

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/documents
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

sortstring

Field to sort by. Allowed fields depend on the resource.

order'asc' | 'desc'

Sort direction.

withCountboolean

Include the total number of matching items. Defaults to false.

folderstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only documents in this folder.

linkedTostring

Only documents linked to this target. Use kind:id, such as transaction:txn_8f2a1c9e.

unassignedboolean

When true, only documents with no links.

projectstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only documents in this project.

status'pending' | 'processing' | 'ready' | 'failed'

The document's extraction status. ready means extracted data is available.

Example:ready

Only documents with this processing status.

classificationstring

Only documents with this classification.

coarseType'financial' | 'tax' | 'legal' | 'insurance' | 'production' | 'other'

The document category found during extraction.

Example:financial

Only documents in this category.

qstring

Search document names and descriptions.

Response

A page of documents.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total results when withCount=true.

truncatedboolean

Whether the page ended before limit because some results were unavailable.

Example response

{
  "data": [
    {
      "id": "doc_4b1f0a7c",
      "name": "vendor-invoice-0425.pdf",
      "mimeType": "application/pdf",
      "size": 184320,
      "status": "ready",
      "workspaceId": "ws_71aa",
      "pageCount": 2,
      "classification": "invoice",
      "coarseType": "financial",
      "folderId": "fld_9c2d",
      "projectId": "prj_71aa",
      "links": [
        {
          "kind": "transaction",
          "id": "txn_8f2a1c9e"
        }
      ],
      "createdAt": "2026-05-28T14:03:11Z",
      "updatedAt": "2026-05-28T14:03:40Z"
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.