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, allowing users to interact programmatically with various resources managed by Paperless NGX. Specifically, for the "Group" resource and the "Get by ID" operation, the node retrieves detailed information about a single group based on its unique numeric ID.
Common scenarios include:
- Fetching metadata or configuration details of a specific group within Paperless NGX.
- Automating workflows that require validation or processing of group-related data.
- Integrating group information into other systems or reports.
For example, a user might use this node to retrieve a group's details before assigning documents or permissions related to that group in an automated document management workflow.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice explaining that owner and permission fields accept numeric IDs. It also suggests retrieving available Users and Groups using the provided node endpoints. |
| Group ID | The unique numeric identifier of the group to retrieve. This is a required field when performing the "Get by ID" operation on the "Group" resource. |
Output
The output JSON will contain the details of the requested group as returned by the Paperless NGX API. This typically includes fields such as the group's ID, name, description, owner, permissions, and any other metadata associated with the group.
If the node supports binary data output (not indicated here), it would represent any file or attachment related to the group, but for this operation, the output is purely JSON-based group information.
Dependencies
- Requires an active connection to the Paperless NGX API.
- Needs an API authentication token or key configured in the node credentials to authorize requests.
- The base URL for the API instance must be correctly set in the node's credential configuration.
Troubleshooting
- Invalid or missing Group ID: Ensure the "Group ID" property is provided and is a valid number corresponding to an existing group.
- Authentication errors: Verify that the API credentials are correct and have sufficient permissions to access group data.
- Network issues: Confirm that the Paperless NGX API endpoint is reachable from the n8n environment.
- API errors: If the group does not exist or has been deleted, the API may return a 404 error. Handle such cases gracefully in your workflow.