Paperless Document Details

Get detailed information about Paperless-ngx documents

Actions3

Document → Get Document by ID

AI-generated

Overview

This node retrieves detailed information about documents from a Paperless-ngx system. Specifically, the "Get Document by ID" operation fetches all available data for a single document identified by its unique ID. This is useful when you need to access or process the full details of a specific document stored in Paperless-ngx, such as for auditing, reporting, or integration with other systems.

Practical examples include:

  • Automatically fetching document details after a new document is added.
  • Integrating document data into external dashboards or workflows.
  • Triggering further processing based on document content or metadata.

Properties

Name Meaning
Document ID The unique numeric identifier of the document to retrieve. This is required to specify which document's details to fetch.

Output

The node outputs a JSON object representing the full details of the requested document. The structure corresponds directly to the Paperless-ngx API response for a document, typically including fields such as document metadata, content references, status, and timestamps.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Paperless-ngx API.
  • The base URL of the Paperless-ngx instance must be configured in the credentials.
  • Network access to the Paperless-ngx API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Document ID will cause the API request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "404 Not Found": The specified Document ID does not exist. Verify the ID is correct.
    • "401 Unauthorized" or "403 Forbidden": Authentication failed. Check API credentials and permissions.
    • Timeout or network errors: Ensure the Paperless-ngx server is reachable and the base URL is correct.

To resolve these, verify input parameters, credentials, and network settings.

Links and References

Discussion