Paperless Documents

Interact with Paperless-ngx documents

Actions2

Document → Get All Documents

AI-generated

Overview

This node interacts with the Paperless-ngx document management system, specifically allowing users to retrieve documents. The "Get All Documents" operation fetches a paginated list of all documents stored in Paperless-ngx, optionally ordered by creation date, modification date, or title.

Common scenarios for this node include:

  • Synchronizing documents from Paperless-ngx into other systems.
  • Displaying or processing a list of documents within an automation workflow.
  • Archiving or backing up document metadata regularly.

For example, you could use this node to pull the latest 50 documents sorted by their creation date to generate a report or trigger further processing steps based on document metadata.

Properties

Name Meaning
Page Page number for pagination; specifies which page of results to retrieve (default: 1).
Page Size Number of items per page; controls how many documents are returned per request (default: 25).
Ordering Ordering of results; options include:
- Created Date (Newest First)
- Created Date (Oldest First)
- Modified Date (Newest First)
- Modified Date (Oldest First)
- Title (A-Z)
- Title (Z-A) (default: Created Date (Newest First))

Output

The node outputs an array of JSON objects, each representing a document retrieved from Paperless-ngx. Each object contains the document's metadata fields as provided by the Paperless-ngx API.

The output does not include binary data; it only returns JSON metadata about the documents such as IDs, titles, dates, and other relevant attributes.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests against the Paperless-ngx API.
  • The base URL of the Paperless-ngx instance must be set in the credential configuration.
  • The node uses HTTP GET requests to the /api/documents/ endpoint of the Paperless-ngx API.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid base URL or network connectivity issues can prevent successful API calls.
    • Requesting pages beyond the available range may return empty results.

  • Error messages:

    • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
    • Network errors suggest checking the Paperless-ngx server availability and URL correctness.
    • If the node throws errors related to query parameters, ensure that "Page", "Page Size", and "Ordering" values are valid and within expected ranges.

Links and References

Discussion