https://github.com/chezmoi-sh/n8n-nodes-paperless
N8N community node manage your documents with Paperless-ngx.
https://github.com/chezmoi-sh/n8n-nodes-paperless
n8n-community-node-package n8n-nodes paperless-ngx
Last synced: 4 months ago
JSON representation
N8N community node manage your documents with Paperless-ngx.
- Host: GitHub
- URL: https://github.com/chezmoi-sh/n8n-nodes-paperless
- Owner: chezmoi-sh
- License: mit
- Created: 2025-01-14T11:55:35.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-02-16T08:23:24.000Z (8 months ago)
- Last Synced: 2025-06-04T09:55:18.604Z (5 months ago)
- Topics: n8n-community-node-package, n8n-nodes, paperless-ngx
- Language: TypeScript
- Homepage:
- Size: 145 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# n8n-nodes-paperless
This is a n8n community node. It lets you use [Paperless-ngx](https://docs.paperless-ngx.com/) in your n8n workflows.
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](#installation)
[Operations](#operations)
[Credentials](#credentials)
[Compatibility](#compatibility)
[Resources](#resources)
## Installation
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
> [!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
### Correspondent
- Create/Update/Delete correspondent
- Get a correspondent
- List all correspondents
### Custom Field
- Create/Update/Delete custom field
- Get a custom field
- List all custom fields
### Document
- Create/Update/Delete document
- Get a document
- Get document history
- Get document metadata
- Get metadata suggestions
- Get document preview
- Get document share links
- List all documents
### Document Metadata
- Get metadata suggestions
### Document Note
- Create/Delete document note
- List document notes
### Document Type
- Create/Update/Delete document type
- Get a document type
- List all document types
### Tag
- Create/Update/Delete tag
- Get a tag
- List all tags
### Task
- Get a task
## AI Tools
This node can also be used to interact with the [AI tools agent](https://docs.n8n.io/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/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](https://github.com/n8n-io/n8n/issues/12593).
## Credentials
You need to provide the following to authenticate:
- Paperless-ngx instance URL
- API token
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.
## Resources
- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
- [Paperless-ngx documentation](https://docs.paperless-ngx.com/)
- [Paperless-ngx API documentation](https://docs.paperless-ngx.com/api/)
## License
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)