Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
The node "Paperless NGX" integrates with the Paperless NGX API, enabling users to manage documents and related entities programmatically within n8n workflows. Specifically, the "Get by ID" operation under the "Document" resource retrieves detailed information about a single document using its unique numeric ID.
This operation is useful in scenarios where you need to fetch metadata or content details of a specific document stored in Paperless NGX, for example:
- Automating document retrieval for processing or review.
- Integrating document data into other systems or workflows.
- Validating document existence or status before further actions.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice explaining that owner and permissions fields accept numeric IDs. It suggests retrieving available Users and Groups via separate API calls using this node. |
| Document ID | The unique numeric identifier of the document to retrieve. This is a required field when performing the "Get by ID" operation on the Document resource. |
Output
The output JSON will contain the detailed data of the requested document as returned by the Paperless NGX API. This typically includes metadata such as:
- Document ID
- Title or name
- Owner and permission information (as numeric IDs)
- Associated tags, storage paths, or custom fields
- Other document-specific attributes managed by Paperless NGX
If the document contains binary data (e.g., the actual file), it may be provided in a binary output field, allowing subsequent nodes to process or download the file content.
Dependencies
- Requires an active connection to the Paperless NGX API, authenticated via an API key credential configured in n8n.
- The node expects the base URL of the Paperless NGX instance to be set in the credentials.
- Proper permissions on the Paperless NGX side to access document data by ID.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Document ID will result in errors or empty responses.
- Insufficient API permissions can cause authorization failures.
- Incorrect or missing API credentials will prevent successful API calls.
Error messages:
- "Document not found": Verify the Document ID exists in your Paperless NGX instance.
- "Unauthorized" or "Forbidden": Check API key validity and user permissions.
- Network or timeout errors: Ensure the Paperless NGX instance URL is reachable from n8n.