Paperless Tags

Interact with Paperless-ngx tags

Actions2

Tag → Get Tag by ID

AI-generated

Overview

This node interacts with the Paperless-ngx document management system to manage tags. Specifically, the "Get Tag by ID" operation retrieves detailed information about a single tag using its unique identifier. This is useful when you need to fetch metadata or properties of a specific tag for further processing, filtering, or display in your workflow.

Practical examples include:

  • Fetching a tag's details to verify its existence before assigning it to documents.
  • Retrieving tag information to display in a user interface or report.
  • Using tag data as part of conditional logic in automation workflows.

Properties

Name Meaning
Tag ID The unique numeric identifier of the tag to retrieve. This property is required for the "Get Tag by ID" operation.

Output

The output is a JSON object representing the tag retrieved from Paperless-ngx. It contains all the tag's properties as returned by the API, such as its name, ID, creation date, and any other metadata associated with the tag.

No binary data is output by this node.

Example output structure (simplified):

{
  "id": 123,
  "name": "Important",
  "created_date": "2023-01-01T12:00:00Z",
  // ... other tag properties
}

Dependencies

  • Requires an API key credential configured for Paperless-ngx with access to the base URL of the Paperless-ngx instance.
  • The node uses this credential to authenticate API requests.
  • The Paperless-ngx API must be accessible from the n8n environment.

Troubleshooting

  • Common issues:

    • Invalid or missing Tag ID: Ensure the Tag ID provided is a valid number and corresponds to an existing tag.
    • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Network or connectivity problems: Confirm that the Paperless-ngx API endpoint is reachable from n8n.

  • Error messages:

    • "error": "Tag not found": The specified Tag ID does not exist. Double-check the ID.
    • Authentication failures typically return HTTP 401 or 403 errors; check credentials.
    • Timeout or connection errors indicate network issues or incorrect base URL configuration.

Links and References

Discussion