Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
The node interacts with the Paperless NGX API to manage tags within the system. Specifically, the "Get by ID" operation for the Tag resource retrieves detailed information about a single tag based on its unique numeric identifier. This is useful when you need to fetch metadata or properties of a specific tag, for example, to display tag details in a workflow or to use tag data in subsequent processing steps.
Practical examples include:
- Fetching a tag's details to verify its existence before associating it with documents.
- Retrieving tag information to update or audit tagging structures.
- Using tag metadata to filter or categorize documents dynamically in automation workflows.
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 dedicated nodes. |
| Tag ID | The unique numeric identifier of the tag to retrieve. This property is required to specify which tag to get by ID. |
Output
The output contains a JSON object representing the tag's details as returned by the Paperless NGX API. This typically includes fields such as the tag's ID, name, description, and possibly ownership or permission-related information (numeric IDs for users and groups). The exact structure depends on the API response but generally provides all relevant metadata about the tag.
No binary data output is expected from this operation.
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.
- To resolve user and group IDs referenced in tag ownership or permissions, additional nodes querying
/api/users/and/api/groups/endpoints are recommended.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Tag ID will likely result in an error or empty response.
- Incorrect or missing API credentials will cause authentication failures.
- Network connectivity problems to the Paperless NGX instance can prevent successful API calls.
Error messages:
- "Tag not found" or similar indicates the specified Tag ID does not exist; verify the ID.
- Authentication errors suggest invalid or expired API keys; reconfigure credentials.
- Timeouts or connection errors imply network issues; check endpoint accessibility.
Links and References
- Paperless NGX API Documentation (for detailed API endpoints and data structures)
- n8n documentation on creating custom nodes