Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
The node integrates with the Paperless NGX API, enabling automation around document management within the Paperless NGX system. Specifically, for the Document - Download operation, it allows users to download a document by specifying its unique numeric ID. This is useful in workflows where documents stored in Paperless NGX need to be retrieved and processed further, such as archiving, analysis, or sharing.
Practical examples include:
- Automatically downloading newly added documents for backup.
- Fetching specific documents based on workflow triggers for content extraction.
- Integrating document retrieval into larger business processes like invoicing or compliance checks.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice explaining that Owner and permissions fields accept numeric IDs. It suggests retrieving available Users and Groups via dedicated API endpoints using this node. |
| Document ID | The unique numeric identifier of the document to download. This is a required field for the download operation. |
Output
The node outputs JSON data representing the downloaded document's content and metadata. Typically, this includes the document's binary data (e.g., PDF, image) encoded appropriately for n8n to handle, along with any relevant metadata fields returned by the Paperless NGX API.
If the document contains binary data, it will be accessible in the node's binary output property, allowing subsequent nodes to process or save the file.
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 permissions on the Paperless NGX API are necessary to access and download documents.
Troubleshooting
- Common issues:
- Invalid or missing Document ID: Ensure the Document ID provided exists and is correct.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- Network or connectivity problems: Confirm that the Paperless NGX instance URL is reachable from n8n.
- Error messages:
- "Document not found" – The specified Document ID does not exist; verify the ID.
- "Unauthorized" or "Forbidden" – Check API credentials and user permissions.
- "Network error" – Check network connectivity and API endpoint availability.