Description
@mephistojb/n8n-nodes-paperless
This is an independent n8n community node package. It lets you use Paperless-ngx in your n8n workflows.
Document updates support Paperless searchable content in addition to document metadata.
They also support expression-friendly JSON arrays for tags and custom fields,
including targeted tag removal while preserving all other document tags.
Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep your paper documents, but lose the cabinet.
Installation
Operations
Credentials
Compatibility
Resources
Installation
Follow the installation guide in the n8n community nodes documentation.
Install this package in n8n as:
@mephistojb/n8n-nodes-paperless
> [!NOTE]
> This node requires the form-data package for handling multipart/form-data requests. It will be automatically installed as a dependency if not already present in your n8n installation.
Operations
The node supports the following resources and operations:
ASN (Archival Series Number)
- Get next ASN
- Create/Update/Delete correspondent
- Get a correspondent
- List all correspondents
- Create/Update/Delete custom field
- Get a custom field
- List all custom fields
- Create/Update/Delete document
- Get a document, including metadata JSON and the original file as binary data
- Get document history
- Get document metadata
- Get metadata suggestions
- Get document preview and thumbnail as binary data
- Include documents with selected tags, exclude documents carrying any selected tag, and limit queue-sized results
- Get document share links
- List all documents, optionally filtered by title, tags, document type, and storage path
- Get metadata suggestions
- Create/Delete document note
- List document notes
- Create/Update/Delete document type
- Get a document type
- List all document types
- Create/Update/Delete tag
- Get a tag
- List all tags
- Create/Update/Delete storage path
- Get a storage path
- List all storage paths
- Get a task
- Paperless-ngx instance URL
- API token
- GitHub repository
- npm package
- n8n community nodes documentation
- Paperless-ngx documentation
- Paperless-ngx API documentation
Correspondent
Custom Field
Document
Document Metadata
Document Note
Document Type
Tag
Storage Path
Task
AI Tools
This node can also be used to interact with the AI tools agent. However, keep in mind that it is currently not officially supported by n8n and needs some changes to the n8n codebase to work. For more details, see this issue.
Credentials
You need to provide the following to authenticate:
The instance URL can be either the Paperless-ngx base URL, such as http://paperless:8000, or the API URL, such as http://paperless:8000/api.
To get your API token:
1. Login to your Paperless-ngx instance
2. Go to your user settings
3. Create a new API token
Compatibility
Requires n8n version 1.0.0 or later and Paperless-ngx version 2.14.0 or later. Earlier versions may work but are not officially supported or tested.
Publishing
The Publish to npm workflow runs on every push to main, when a stable GitHub release is published, and when manually started from the GitHub Actions page.
1. Configure a trusted GitHub Actions publisher for the package on npmjs.com using repository MephistoJB/n8n-nodes-paperless-ngx and workflow publish-npm.yml.
2. Push a change to main, manually run the workflow, or create a GitHub release whose tag matches the package version.
If the version already exists on npm, push and manual runs automatically increment the patch version before publishing and commit that version back to main. Stable releases keep their explicit tag version. The workflow type checks the project, runs the package’s prepublish build and lint checks, and publishes the scoped package through npm trusted publishing with automatic provenance.
