Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

This node integrates with the Paperless NGX API to retrieve user information. Specifically, the "User" resource with the "Get" operation allows you to fetch a paginated list of users from the Paperless NGX system. It supports filtering and sorting options to narrow down the results based on username patterns.

Common scenarios for this node include:

  • Synchronizing user lists from Paperless NGX into other systems.
  • Automating user management workflows by retrieving user details.
  • Filtering users dynamically based on partial or exact username matches.

For example, you could use this node to get all users whose usernames start with "admin" or to paginate through all users 25 at a time sorted by a specific field.

Properties

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

Output

The node outputs JSON data representing the retrieved users. The structure typically includes an array of user objects containing user details as provided by the Paperless NGX API. Each user object may contain fields such as username, ID, and other metadata relevant to the user.

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 /api/users/ for fetching user data.

Troubleshooting

  • Empty results: Check that the filter parameters are correct and that the page and page size values are within valid ranges.
  • Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Invalid sort field: If sorting by a field not supported by the API, the request may fail or ignore the sort parameter.
  • API connectivity issues: Verify network access to the Paperless NGX instance URL and that the instance is running.

Links and References

Discussion