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 perform operations related to custom fields, specifically allowing retrieval of a custom field by its ID. This is useful in scenarios where you need to fetch detailed information about a specific custom field configured in your Paperless NGX instance, such as for document metadata management or dynamic form handling.
For example, you might use this node to get the properties of a custom field before updating documents that use it, or to display custom field details in an automation workflow.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice explaining that owner and permissions fields accept numeric IDs, and how to retrieve available Users and Groups using other nodes. |
| Custom Field ID | The numeric ID of the custom field to retrieve. This is required to specify which custom field to get from the API. |
Output
The node outputs JSON data representing the custom field object retrieved from the Paperless NGX API. This typically includes all properties of the custom field such as its ID, name, type, and any configuration details defined in the system.
If the node supports binary data output (not indicated here), it would represent associated files or attachments, but for this operation, the output is purely JSON describing the custom field.
Dependencies
- Requires an active connection to the Paperless NGX API.
- Needs an API authentication token or key configured in the node credentials.
- The base URL for the API is dynamically set based on user-provided credentials.
- No additional external dependencies beyond the Paperless NGX API.
Troubleshooting
Common issues:
- Invalid or missing Custom Field ID will cause the request to fail.
- Incorrect API credentials or base URL misconfiguration can lead to authentication errors.
- Network connectivity problems may prevent reaching the Paperless NGX API.
Error messages:
- "Custom Field not found" — Verify the ID exists in your Paperless NGX instance.
- "Authentication failed" — Check that the API key/token is correct and has necessary permissions.
- "Network error" — Ensure the API endpoint URL is reachable and no firewall blocks the request.
Links and References
- Paperless NGX API Documentation
- n8n Documentation on HTTP Request Nodes (for understanding API calls)