Documents

List Documents

Lists documents with cursor-based pagination support. Documents can be sorted and filtered.

The response includes a list of documents along with pagination metadata (next_cursor and prev_cursor) and total document count. The cursors are Base64 URL encoded JSON arrays containing direction and cursor information used for pagination.

get/api/documents

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Query parameters

page_sizeinteger

The number of items to return per page

cursorstring

The cursor to use for pagination

titlestring

String to filter by Document Title

document_id_prefixstring

Filter documents by document ID prefix. Case sensitive.

order_by'title' | 'created_at'

The field to order by

order_direction'asc' | 'desc'

Order in ascending or descending direction

count_remainingboolean

Calculate document counts before and after the current page.

Response

List of documents matching the query parameters.

next_cursorstring nullable

Base64 URL encoded cursor for fetching next page

prev_cursorstring nullable

Base64 URL encoded cursor for fetching previous page

document_countinteger required

Total number of documents

prev_document_countinteger

Number of documents before the current page. Only returned when count_remaining parameter is set to true.

next_document_countinteger

Number of documents after the current page. Only returned when count_remaining parameter is set to true.

Example response

{
  "data": [
    {
      "passwordProtected": true,
      "sourcePdfSha256": "1defd934dbbf77587eb9b7f45d162d2a3aea16c840a9e7cfa190fb2ea1f40a76",
      "title": "Nutrient Document Engine API Specification",
      "byteSize": 192000,
      "createdAt": "2019-09-16T15:05:03.712909Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.