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.

Full-text search documents.

By default per-hit OCR content is stripped; pass include_content=True to get full OCR text per hit. Use more_like for similarity search.

notes[].note and custom_fields[].value are always stripped from search hits regardless of include_content — fetch them via get_document or get_document_notes when needed.

Fetch one document by ID.

By default, the OCR content is stripped to keep responses small. Pass include_content=True for the full text, or call get_document_content to retrieve just the text.

Return the OCR'd text content of a document.

Return the document's thumbnail as inline image content.

Return technical metadata for a document (checksums, filenames, etc.).

Return notes attached to a document.

Return the audit history for a document.

Return Paperless's classifier suggestions for a document.

Patch selected fields on a document.

The response strips OCR content by default; pass include_content=True to get the full text back.

Delete a document.

Upload a document. Returns the task UUID for polling via get_task.

Apply a bulk operation to a set of documents.

Append a note to a document.

Remove a note from a document.

List tags.

Fetch a tag by ID.

Create a new tag.

Patch selected fields on a tag.

Delete a tag.

Apply a bulk operation to a set of tags.

List correspondents.

Fetch a correspondent by ID.

Create a new correspondent.

Patch selected fields on a correspondent.

Delete a correspondent.

Apply a bulk operation to a set of correspondents.

List document types.

Fetch a document type by ID.

Create a new document type.

Patch selected fields on a document type.

Delete a document type.

Apply a bulk operation to a set of document types.

List custom fields.

Fetch a custom field by ID.

Create a new custom field.

extra_data depends on data_type:

• string, longtext, integer, boolean, float, date, url, documentlink — unused; omit or pass null.

• monetary — optional {"default_currency": "USD"} (ISO-4217).

• select — extra_data required: {"select_options": [{"label": "Low"}, {"label": "Medium"}]}. Paperless assigns each option a stable id on creation.

Unknown shapes are rejected by Paperless with a 400.

Patch selected fields on a custom field definition.

extra_data shape depends on data_type:

• monetary — optional {"default_currency": "USD"} (ISO-4217).

• select — extra_data.select_options replaces the current list wholesale. To preserve existing values, include each existing option with its server-assigned id: {"select_options": [{"id": "abc", "label": "Low"}, ...]}. Omitting an option's id creates a new option; dropping an option from the list deletes it and any document values referencing it.

See create_custom_field for the full extra_data shape table.

Delete a custom field.

List storage paths.

Fetch a storage path by ID.

List saved views.

Fetch a saved view by ID.

List share links (optionally filtered by document).

Fetch a share link by ID.

List Paperless Celery tasks.

Defaults to unacknowledged tasks only (set include_acknowledged=True or acknowledged=True to see acknowledged ones). Returns one page.

Fetch a task by UUID. Returns None if no such task exists.

Poll until the task reaches a terminal state or times out.

Fetch collection-level statistics.

Fetch Paperless version info.