Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node interacts with the Paperless NGX API to retrieve documents based on various filtering criteria. It is designed to fetch document records from a Paperless NGX instance, supporting pagination, sorting, and detailed permission inclusion.

This node is beneficial in scenarios where users need to programmatically access and manage document metadata stored in Paperless NGX, such as automating document retrieval for processing, reporting, or integration with other systems.

Practical examples:

  • Retrieve all documents created after a certain date for audit purposes.
  • Fetch documents tagged with specific tags to automate categorization workflows.
  • Get documents containing specific keywords in their title or content for search automation.

Properties

Name Meaning
Note Owner and permissions fields accept numeric IDs. Retrieve available Users and Groups using the provided node.
Page Page number to retrieve (for paginated results).
Page Size Number of items to return per page.
Sort By Field to sort the results by.
Full Permissions Whether to include full permission information in the response (boolean).
Filter by IDs Filter documents by multiple IDs (comma-separated list).
Title Contains Filter documents where the title contains this text (case-insensitive).
Content Contains Filter documents where the content contains this text (case-insensitive).
Tags (IDs) Filter documents by tag IDs (comma-separated list).
Document Type ID Filter documents by document type ID (numeric).
Correspondent ID Filter documents by correspondent ID (numeric).
Storage Path ID Filter documents by storage path ID (numeric).
ASN Contains Filter documents where archive serial number contains this text.
Created After Filter documents created after this date/time.
Created Before Filter documents created before this date/time.
Modified After Filter documents modified after this date/time.
Modified Before Filter documents modified before this date/time.

Output

The node outputs JSON data representing the retrieved documents matching the specified filters. Each item in the output corresponds to a document object with its metadata fields as returned by the Paperless NGX API.

If the "Full Permissions" option is enabled, the output includes detailed permission information for each document.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to a Paperless NGX instance via an API key credential.
  • The node expects the base URL of the Paperless NGX API instance to be configured in the credentials.
  • Proper API authentication token or key must be provided to authorize requests.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid filter values (e.g., non-numeric IDs where numbers are expected) may result in errors or empty responses.
    • Pagination parameters out of range might lead to no results being returned.
  • Error messages:
    • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
    • Validation errors on filters suggest checking the input types and formats.
    • Network or connectivity errors require ensuring the Paperless NGX instance URL is reachable from n8n.

Links and References

Discussion