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 retrieve information about storage paths. Specifically, the "Get" operation under the "Storage Path" resource allows users to fetch a list of storage paths or details of specific storage paths based on various filtering and sorting criteria.
This node is beneficial in scenarios where you need to programmatically access storage path metadata from Paperless NGX for automation workflows, such as syncing storage paths with other systems, auditing storage locations, or dynamically managing document storage configurations.
Practical examples:
- Retrieve all storage paths that start with a certain prefix to verify naming conventions.
- Fetch storage paths filtered by IDs or names containing specific text for reporting.
- Get detailed permission information on storage paths to audit user/group access.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice about using numeric IDs for owner and permissions fields; suggests retrieving users and groups via separate API calls. |
| Page | Page number to retrieve (pagination control). |
| Page Size | Number of items to return per page (pagination control). |
| Sort By | Field name to sort the results by. |
| Storage Path ID | The unique numeric ID of the storage path to get. Required when fetching a specific storage path. |
| Full Permissions | Boolean flag indicating whether to include full permission details in the response. |
| Filter by IDs | Comma-separated list of storage path IDs to filter the results by. |
| Name Contains | Filter storage paths where the name contains this text (case-insensitive). |
| Name Ends With | Filter storage paths where the name ends with this text (case-insensitive). |
| Name Exact Match | Filter storage paths where the name exactly matches this text (case-insensitive). |
| Name Starts With | Filter storage paths where the name starts with this text (case-insensitive). |
| Path Contains | Filter storage paths where the path contains this text (case-insensitive). |
| Path Ends With | Filter storage paths where the path ends with this text (case-insensitive). |
| Path Exact Match | Filter storage paths where the path exactly matches this text (case-insensitive). |
| Path Starts With | Filter storage paths where the path starts with this text (case-insensitive). |
Output
The node outputs JSON data representing storage path objects retrieved from the Paperless NGX API. Each item typically includes properties such as the storage path's ID, name, path string, and optionally detailed permission information if requested.
If the "Full Permissions" option is enabled, the output will include comprehensive permission details related to users and groups associated with each storage path.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the Paperless NGX instance.
- The node expects the base URL of the Paperless NGX API instance to be configured in the credentials.
- Pagination and filtering parameters depend on the Paperless NGX API capabilities.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Requesting a storage path by an ID that does not exist will likely result in a "not found" error.
- Using invalid filter values or unsupported sort fields may cause API errors.
- Pagination parameters out of range might return empty results.
Error messages:
- Authentication errors: Verify that the API key and instance URL are correctly set.
- Not found errors: Confirm the storage path ID exists before requesting.
- Validation errors: Check that filter and sort parameters conform to expected formats.