Paperless Tags

Interact with Paperless-ngx tags

Actions2

Tag → Get All Tags

AI-generated

Overview

This node interacts with the Paperless-ngx document management system to manage tags. Specifically, the "Get All Tags" operation retrieves a paginated list of all tags available in the Paperless-ngx instance. This is useful for workflows that need to categorize, filter, or display documents based on their tags.

Common scenarios include:

  • Fetching all tags to present them as options in a user interface.
  • Synchronizing tags from Paperless-ngx into another system.
  • Automating document classification by retrieving tag metadata.

For example, you might use this node to get all tags sorted alphabetically and then loop through them to perform further actions like fetching documents associated with each tag.

Properties

Name Meaning
Page Page number for pagination. Determines which page of results to retrieve.
Page Size Number of items per page. Controls how many tags are returned in one request.
Ordering Ordering of results. Options:
- Name (A-Z)
- Name (Z-A)
- Created Date (Newest First)
- Created Date (Oldest First)

Output

The output is an array of JSON objects representing tags. Each tag object contains the properties as returned by the Paperless-ngx API's /api/tags/ endpoint. The exact structure depends on the API but typically includes fields such as tag ID, name, creation date, and possibly other metadata.

No binary data is output by this node.

Example output snippet:

[
  {
    "id": 1,
    "name": "Invoices",
    "created_date": "2023-01-15T12:34:56Z"
  },
  {
    "id": 2,
    "name": "Receipts",
    "created_date": "2023-02-10T08:22:11Z"
  }
]

Dependencies

  • Requires an API key credential configured for Paperless-ngx with access to its REST API.
  • The node uses the base URL provided in the credentials to make authenticated HTTP GET requests to the /api/tags/ endpoint.
  • Proper network connectivity to the Paperless-ngx server is necessary.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Pagination issues: If no tags appear, verify that the Page and Page Size parameters are set correctly and that there are tags available on the requested page.
  • Ordering not applied: Confirm that the ordering parameter matches one of the allowed values; otherwise, the API may ignore it or return an error.
  • API connectivity problems: Check the base URL and network access to the Paperless-ngx server.

If the node throws an error related to request failure, inspect the error message for HTTP status codes or messages indicating invalid credentials, missing permissions, or incorrect endpoint URLs.

Links and References

Discussion