List Documents
list_documentsLists documents with optional filters for tags, correspondent, document type, storage path, or custom field. Returns one page of metadata, excluding OCR content and note values.
Instructions
List documents with optional filters. Returns one page.
Per-document OCR content is stripped to keep results small. Use
get_document_content for a bounded preview of one result.
notes[].note and custom_fields[].value are always stripped
from listings. The metadata refs
(note ids, timestamps, custom-field ids) are retained so callers can
detect presence; use get_document or get_document_notes to read
those values.
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 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | ||
| count | Yes | ||
| results | No | ||
| previous | No |