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, allowing users to interact programmatically with various resources such as Correspondents, Documents, Document Types, Storage Paths, Tags, Custom Fields, Users, and Groups. Specifically, for the "Correspondent" resource with the "Get by ID" operation, the node retrieves detailed information about a single correspondent identified by its unique numeric ID.
This functionality is useful in scenarios where you need to fetch specific correspondent details from your Paperless NGX instance, for example, to display correspondent data in workflows, validate correspondent existence before processing documents, or synchronize correspondent information with other systems.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice explaining that Owner and permissions fields accept numeric IDs. It suggests retrieving available Users and Groups via their respective API endpoints using this node. |
| Correspondent ID | The unique numeric identifier of the correspondent to retrieve. This property is required for the "Get by ID" operation on the Correspondent resource. |
Output
The node outputs JSON data representing the correspondent object retrieved from the Paperless NGX API. This JSON typically includes all relevant fields describing the correspondent, such as their name, contact details, and any associated metadata stored in the system.
If the node supports binary data output (not indicated here), it would represent attachments or files related to the correspondent, but based on the provided code and properties, the output is purely JSON.
Dependencies
- Requires an active connection to a Paperless NGX instance.
- Needs an API authentication token or key configured in the node credentials to authorize requests.
- The base URL for API requests is dynamically constructed from the credential's instance URL.
- No additional external services are required beyond the Paperless NGX API.
Troubleshooting
Common Issues:
- Invalid or missing Correspondent ID will cause the request to fail.
- Incorrect or expired API credentials will result in authentication errors.
- Network connectivity issues to the Paperless NGX instance can prevent successful API calls.
Error Messages:
- 404 Not Found: The specified Correspondent ID does not exist. Verify the ID is correct.
- 401 Unauthorized: Authentication failed. Check API credentials and permissions.
- 400 Bad Request: Input parameters may be malformed or missing; ensure the Correspondent ID is provided and valid.
Resolutions:
- Confirm the Correspondent ID exists by listing correspondents first.
- Re-enter or update API credentials.
- Ensure the Paperless NGX instance URL is reachable and correct.