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 detailed information about a specific user by their unique ID. This operation is useful when you need to fetch user details such as permissions, ownership, or other metadata associated with a user in the Paperless NGX system. Practical scenarios include automating user management workflows, auditing user access, or integrating user data into other systems.

Properties

Name Meaning
Note Informational message indicating that owner and permission fields accept numeric IDs. It also suggests retrieving available Users and Groups using this node.
User ID The unique numeric identifier of the user to retrieve. This is a required field for the "Get by ID" operation under the "User" resource.

Output

The output JSON contains the detailed information of the requested user fetched from the Paperless NGX API. This typically includes user attributes such as ID, username, email, permissions, groups, and other relevant metadata defined by the API. The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Paperless NGX API.
  • The base URL for API requests is configured dynamically based on the provided instance URL credential.
  • The node expects the Paperless NGX API to be accessible and properly configured.

Troubleshooting

  • Common Issues:
    • Invalid or missing User ID: Ensure the User ID is provided and corresponds to an existing user.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or connectivity issues: Confirm that the Paperless NGX instance URL is correct and reachable.
  • Error Messages:
    • "User not found": Indicates the specified User ID does not exist; verify the ID.
    • "Unauthorized" or "Forbidden": Check API credentials and permissions.
    • Timeout or network errors: Check network connectivity and API availability.

Links and References

Discussion