Paperless Documents

Interact with Paperless-ngx documents

Actions2

Document → Get Documents by Tags

AI-generated

Overview

This node interacts with Paperless-ngx to retrieve documents filtered by tags. It is useful when you want to fetch specific documents from your Paperless-ngx instance based on their associated tags, supporting pagination and ordering of results. For example, you can use it to get all documents tagged with "invoice" and "2023" sorted by creation date, or to paginate through large sets of tagged documents.

Properties

Name Meaning
Tags Comma-separated list of tag names or IDs used to filter the documents (required).
Page Page number for pagination; controls 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 document objects in the json field. Each object represents a document retrieved from Paperless-ngx matching the specified tags and pagination parameters. The structure corresponds directly to the API response for documents, typically including metadata such as document ID, title, creation and modification dates, tags, and other relevant document details.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured for authenticating with the Paperless-ngx API.
  • The base URL of the Paperless-ngx instance must be set in the node credentials.
  • 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.
    • Providing invalid tag names or IDs may result in empty responses.
    • Pagination parameters out of range might return no results.
  • Error messages:
    • Authentication errors usually indicate invalid or missing API keys; verify credentials.
    • Network errors suggest connectivity issues with the Paperless-ngx server.
    • If the node returns an error message in the output JSON under error, check the message for details.
  • To resolve errors, ensure correct API credentials, valid tag inputs, and that the Paperless-ngx server is reachable.

Links and References

Discussion