Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
This node integrates with the Paperless NGX API to create a new tag within the system. Tags in Paperless NGX are used to categorize and organize documents, enabling easier search and automated document management based on content matching rules.
Typical use cases include:
- Automatically tagging incoming documents based on their content.
- Organizing documents by color-coded tags for visual identification.
- Assigning ownership and permissions to tags for controlled access.
- Setting tags that automatically apply to all new documents (inbox tags).
For example, you might create a tag named "Invoices" with a red color and a matching rule that looks for the word "invoice" in document contents, so all invoices get tagged automatically.
Properties
| Name | Meaning |
|---|---|
| Note (globalPermissionsNote) | Informational notice explaining that owner and permission fields accept numeric IDs, and users/groups can be retrieved via separate API calls. |
| Name (name) | The name of the tag to create. This is a required string field. |
| Color (color) | The color of the tag represented as a hex color code (e.g., #FF0000). |
| Match (match) | A string pattern that Paperless NGX will try to match against document contents to assign this tag automatically. |
| Matching Algorithm (matchingAlgorithm) | The algorithm used to match documents to this tag. Options include: None, Any (match any word), All (match all words), Literal (exact string), Regular Expression, Fuzzy Match, Auto (automatic selection). |
| Case Insensitive (isInsensitive) | Boolean flag indicating whether the matching should ignore case differences. |
| Is Inbox Tag (isInboxTag) | Boolean flag indicating if this tag should be automatically assigned to all new documents (i.e., act as an inbox tag). |
| Owner User ID (owner) | Numeric user ID to set as the owner of this tag. |
| Set Permissions (setPermissions) | JSON object defining view and change permissions for users and groups. Structure: {"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}. Users and groups must be specified by their numeric IDs. |
| Note (permissionsNote) | Informational notice reminding users to retrieve user and group IDs from the respective endpoints, as this node does not provide create/update/delete operations for users or groups. |
Output
The node outputs JSON data representing the newly created tag object as returned by the Paperless NGX API. This typically includes fields such as the tag's ID, name, color, matching rules, ownership, and permissions.
No binary data output is produced by this node.
Dependencies
- Requires an active connection to a Paperless NGX instance via its REST API.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- Users and groups referenced in ownership and permissions must exist in the Paperless NGX system; their numeric IDs need to be obtained separately (e.g., via dedicated nodes querying
/api/users/and/api/groups/).
Troubleshooting
- Invalid or missing API credentials: Ensure the API key/token and instance URL are correctly configured in the node credentials.
- Incorrect user/group IDs: Permissions and ownership require valid numeric IDs. Using invalid or non-existent IDs will cause errors. Retrieve these IDs beforehand using appropriate API calls.
- Malformed JSON in permissions: The
setPermissionsproperty expects a well-formed JSON object. Invalid JSON syntax will cause request failures. - Matching algorithm misconfiguration: Selecting an inappropriate matching algorithm or providing an invalid match string may result in unexpected tagging behavior.
- API endpoint errors: Network issues or incorrect base URL configuration can prevent communication with the Paperless NGX API.