Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node interacts with the Paperless NGX API to retrieve information about custom fields. Specifically, the "Get" operation for the "Custom Field" resource allows users to fetch one or multiple custom fields based on various filtering criteria such as IDs, name patterns, pagination, and sorting options.

This node is beneficial in scenarios where you need to programmatically access metadata about custom fields defined in a Paperless NGX instance, for example:

  • Synchronizing custom field definitions with another system.
  • Displaying or processing custom field data within an automation workflow.
  • Filtering and retrieving specific custom fields by name or ID for further operations.

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.
Page Page number of results to retrieve (for paginated responses).
Page Size Number of items to return per page.
Sort By Field name to sort the results by.
Custom Field ID The unique numeric ID of the custom field to get. This is required when fetching a single custom field.
Filter by IDs Comma-separated list of custom field IDs to filter the results by multiple IDs.
Name Contains Filter custom fields whose names contain this text (case-insensitive).
Name Ends With Filter custom fields whose names end with this text (case-insensitive).
Name Exact Match Filter custom fields whose names exactly match this text (case-insensitive).
Name Starts With Filter custom fields whose names start with this text (case-insensitive).

Output

The output JSON contains the retrieved custom field(s) data from the Paperless NGX API. Each item typically includes details such as the custom field's ID, name, type, and any other metadata provided by the API.

If multiple custom fields are retrieved (e.g., via filters or pagination), the output will be an array of these objects.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Paperless NGX API.
  • The node expects the base URL of the Paperless NGX instance to be configured in the credentials.
  • The API endpoint used is under /api/customfields/ or similar, depending on the operation.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Providing an invalid custom field ID may result in a "not found" error.
    • Incorrect pagination parameters might lead to empty results.
    • Filters that do not match any custom fields will return empty arrays.

  • Error messages:

    • Authentication failures: Check that the API key and instance URL are correctly set.
    • 404 Not Found: Verify the custom field ID exists.
    • Validation errors: Ensure numeric fields like page and page size are positive integers.

Links and References

Discussion