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 to retrieve information about correspondents. Specifically, the "Get" operation for the "Correspondent" resource allows users to fetch a list of correspondents or details of specific correspondents based on various filtering and sorting criteria. This is useful in scenarios where you need to automate document management workflows by accessing correspondent data such as names and permissions.
Practical examples include:
- Retrieving a paginated list of correspondents to display in a dashboard.
- Filtering correspondents whose names match certain patterns for targeted processing.
- Fetching detailed permission information for correspondents to manage access control.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice about using numeric IDs for owner and permissions fields; suggests retrieving Users and Groups via provided nodes. |
| Page | Page number to retrieve (for pagination). |
| Page Size | Number of items to return per page (pagination size). |
| Sort By | Field name to sort the results by. |
| Correspondent ID | The unique numeric ID of the correspondent to get. Required when fetching a specific correspondent. |
| Full Permissions | Boolean flag indicating whether to include full permission information in the response. |
| Filter by IDs | Comma-separated list of correspondent IDs to filter the results by multiple IDs. |
| Name Contains | Filter correspondents whose names contain this text (case-insensitive). |
| Name Ends With | Filter correspondents whose names end with this text (case-insensitive). |
| Name Exact Match | Filter correspondents whose names exactly match this text (case-insensitive). |
| Name Starts With | Filter correspondents whose names start with this text (case-insensitive). |
Output
The output JSON contains the retrieved correspondent data from the Paperless NGX API. This typically includes correspondent details such as their IDs, names, and optionally their full permission information if requested. The structure corresponds directly to the API's response format for correspondents.
If binary data were involved (not indicated here), it would represent file contents or attachments, but this node focuses on JSON data representing metadata about correspondents.
Dependencies
- Requires an API key credential for authenticating with the Paperless NGX API.
- The node expects the base URL of the Paperless NGX instance to be configured in the credentials.
- No additional external dependencies beyond the API and n8n environment are required.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Providing invalid correspondent IDs or filters may result in empty responses or errors.
- Pagination parameters out of range might lead to no data returned.
Error messages:
- Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
- Validation errors on input properties suggest incorrect types or missing required fields; ensure all required inputs are correctly set.
- Network or connectivity errors imply issues reaching the Paperless NGX instance; check network settings and instance URL.