Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node provides integration with the Paperless NGX API, allowing users to manage various resources such as Correspondents, Documents, Document Types, Storage Paths, Tags, Custom Fields, Users, and Groups. Specifically, for the "Correspondent" resource with the "Delete" operation, this node enables the deletion of a correspondent by its unique ID.

This functionality is useful in scenarios where you need to programmatically remove correspondents from your Paperless NGX system, for example, cleaning up outdated or incorrect entries automatically as part of a workflow.

Practical example:

  • Automatically delete a correspondent after their associated documents have been archived or removed.
  • Clean up test data correspondents created during development or testing phases.

Properties

Name Meaning
Note Informational notice explaining that Owner and permissions fields accept numeric IDs. It suggests retrieving available Users and Groups via provided API endpoints using this node.
Correspondent ID The numeric ID of the correspondent to delete. This is a required field when performing the delete operation on a correspondent.

Output

The output of the node after deleting a correspondent will typically be a JSON object reflecting the result of the delete operation. Usually, this might include confirmation of deletion or status information returned by the Paperless NGX API.

Since this operation is a deletion, no binary data output is expected.

Example output structure (conceptual):

{
  "success": true,
  "message": "Correspondent deleted successfully",
  "id": 123
}

Dependencies

  • Requires an active connection to the Paperless NGX API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the API instance must be set correctly in the credentials configuration.
  • To use the "Correspondent ID" property effectively, users may need to retrieve valid correspondent IDs beforehand, possibly using other operations or nodes.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Correspondent ID will likely cause the API to return an error indicating the correspondent was not found.
    • Missing or incorrect API credentials will result in authentication errors.
    • Network connectivity problems can prevent the node from reaching the Paperless NGX API.

  • Error messages and resolutions:

    • "404 Not Found" — The specified correspondent ID does not exist. Verify the ID before attempting deletion.
    • "401 Unauthorized" or "403 Forbidden" — Check that the API credentials are correct and have sufficient permissions.
    • "Network Error" — Ensure the API base URL is reachable and there are no firewall or proxy issues blocking access.

Links and References

Discussion