query_documents
Query Paperless documents using full-text search and structured filters, including custom fields and documented API parameters for complex retrieval.
Instructions
Query documents using the full-text query engine plus structured Paperless filters. Use this for complex filtering, custom field conditions, or any documented /api/documents/ query parameters that are not exposed as first-class arguments. Prefer the dedicated top-level arguments where available. custom_field_query supports [field_name_or_id, operator, value] leaves or ['AND'|'OR', [clause1, clause2]] groups. Note: Document content is excluded from results by default. Use 'get_document_content' when you need the document text.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | ||
| page | No | ||
| query | No | ||
| search | No | ||
| ordering | No | ||
| page_size | No | ||
| more_like_id | No | ||
| storage_path | No | ||
| correspondent | No | ||
| document_type | No | ||
| paperless_filters | No | Additional documented /api/documents/ Paperless filters. Keys must match Paperless query parameter names exactly. Prefer first-class arguments when available. | |
| created__date__gte | No | ||
| created__date__lte | No | ||
| custom_field_query | No | Paperless custom field query. Use [field_name_or_id, operator, value] for a single clause or ['AND'|'OR', [clause1, clause2]] for grouped clauses. | |
| archive_serial_number | No | ||
| custom_fields__icontains | No | ||
| archive_serial_number__isnull | No |