list_documents
List documents using filters like tags, correspondent, or document type to find and retrieve one page of results.
Instructions
List documents with optional filters. Returns one page.
By default, per-document OCR content is stripped to keep results
small. Pass include_content=True for the full text on each hit.
notes[].note and custom_fields[].value are always stripped
from listings regardless of include_content — the metadata refs
(note ids, timestamps, custom-field ids) are retained so callers can
detect presence, but to read the actual text use get_document
(with include_content=True if needed) or get_document_notes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| tags | No | ||
| ordering | No | ||
| page_size | No | ||
| custom_field | No | ||
| storage_path | No | ||
| correspondent | No | ||
| document_type | No | ||
| include_content | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | ||
| count | Yes | ||
| results | No | ||
| previous | No |