Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node "Paperless NGX" integrates with the Paperless NGX API, allowing users to interact programmatically with various resources such as groups, documents, users, and more. Specifically, the Group - Get operation retrieves a paginated list of groups from the Paperless NGX system. This is useful for workflows that need to fetch group information for further processing, filtering, or decision-making.

Common scenarios include:

  • Synchronizing group data from Paperless NGX into another system.
  • Filtering groups based on name patterns to trigger specific workflow branches.
  • Retrieving group metadata for reporting or auditing purposes.

Example: A user wants to get all groups whose names start with "Admin" and process them in a workflow to assign permissions accordingly.

Properties

Name Meaning
Note Informational notice about using numeric IDs for owner and permissions fields.
Page Page number to retrieve (pagination control).
Page Size Number of items to return per page (pagination control).
Sort By Field name by which to sort the results.
Name Contains Filter groups where the group name contains this text (case-insensitive).
Name Ends With Filter groups where the group name ends with this text (case-insensitive).
Name Exact Match Filter groups where the group name exactly matches this text (case-insensitive).
Name Starts With Filter groups where the group name starts with this text (case-insensitive).

Output

The node outputs JSON data representing the retrieved groups. The structure typically includes an array of group objects, each containing details such as group ID, name, and possibly other metadata as provided by the Paperless NGX API.

If binary data were involved, it would be summarized here, but this operation deals only with JSON data.

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.
  • No additional external dependencies are required beyond the API access.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Pagination parameters out of range may result in empty responses.
    • Using invalid filter values might lead to no matching groups found.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • HTTP errors related to connectivity suggest checking the instance URL and network access.
    • If no groups are returned, confirm that the filter criteria match existing group names.

Links and References

Discussion