Requirements
Before you set up the credential, make sure you have an active Paperless-ngx account and an API access token from your account settings ready.[3]
Get your Paperless-ngx credentials
Connect Paperless-ngx in WEXTL
- Log in to your WEXTL account, add the Paperless-ngx node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Paperless-ngx account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Paperless-ngx node modules
The list below is a reference of every Paperless-ngx node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Paperless-ngx node module below opens to reveal its input parameters, outputs, and connection requirements.
Output fields[3]
| Field | Type |
|---|---|
ID | number |
User args | text |
Barcode tag mapping | text |
Llm API key | text |
Output type | text |
Pages | number |
Language | text |
Mode | text |
32other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Last Correspondence | text |
3other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Data Type | text |
Extra Data | text |
Document Count | number |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Timestamp | date |
Action | text |
Changes | object |
Actor | object |
Id | number |
Username | text |
Output fields[3]
| Field | Type |
|---|---|
ID | number |
Correspondent | number |
Document type | number |
Storage path | number |
Title | text |
Content | text |
Tags | array |
Created | text |
17other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Owner | number |
2other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Permissions | array |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Imap Server | text |
Imap Port | number |
Imap Security | text |
Username | text |
Password | text |
Character Set | text |
5other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Account | number |
Enabled | boolean |
Folder | text |
Filter From | text |
Filter To | text |
Filter Subject | text |
19other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Owner | number |
Rule | number |
Folder | text |
Uid | text |
Subject | text |
Received | date |
Processed | date |
2other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Rule Type | text |
Value | text |
Page Size | number |
Display Mode | text |
Display Fields | text |
3other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Path | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
2other output fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Color | text |
Text Color | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
6other output fields
Output fields[3]
| Field | Type |
|---|---|
ID | number |
Task ID | text |
Task Type | text |
Status | text |
Date Created | date |
Date Done | date |
Output fields[3]
| Field | Type |
|---|---|
ID | number |
Username | text |
Email address | |
First Name | text |
Last Name | text |
Date Joined | date |
Output fields[3]
| Field | Type |
|---|---|
ID | number |
Name | text |
Order | number |
Enabled | boolean |
Input fields[3]
| Field | Type |
|---|---|
TermRequired | text |
Limit | number |
Input fields[3]
| Field | Type |
|---|---|
Document IdRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
Original Checksum | text |
Original Size | number |
Original Mime Type | text |
Media Filename | text |
Has Archive Version | boolean |
Original Metadata | array |
Namespace | text |
Prefix | text |
Key | text |
Value | text |
Archive Checksum | text |
Archive Media Filename | text |
4other output fields
Input fields[3]
| Field | Type |
|---|---|
Document IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
Log IdRequired | text |
Limit | number |
No fields documented.
No fields documented.
Input fields[3]
| Field | Type |
|---|---|
DocumentsRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
Selected Correspondents | array |
Id | number |
Document Count | number |
Selected Tags | array |
Id | number |
Document Count | number |
Selected Document Types | array |
Id | number |
Document Count | number |
Selected Storage Paths | array |
Id | number |
Document Count | number |
Selected Custom Fields | array |
Id | number |
Document Count | number |
No fields documented.
No fields documented.
Output fields[3]
| Field | Type |
|---|---|
Pngx Version | text |
Server Os | text |
Install Type | text |
Storage | object |
Total | number |
Available | number |
Database | object |
Type | text |
Url | text |
Status | text |
Error | text |
Migration Status | object |
Tasks | object |
Redis Url | text |
Redis Status | text |
Redis Error | text |
Celery Status | text |
Summary | object |
Index | object |
Status | text |
Error | text |
Last Modified | date |
Classifier | object |
Status | text |
Error | text |
Last Trained | date |
1other output field
No fields documented.
Output fields[3]
| Field | Type |
|---|---|
Email | |
Password | text |
First Name | text |
Last Name | text |
Auth Token | text |
Social Accounts | array |
Id | number |
Provider | text |
Name | text |
Has Usable Password | boolean |
Is Mfa Enabled | boolean |
Input fields[3]
| Field | Type |
|---|---|
Correspondent Id | choice |
Full Perms | boolean |
Id In | choice |
Name Icontains | text |
Name Iendswith | text |
Name Iexact | text |
Name Istartswith | text |
Ordering | text |
1other input field
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Last Correspondence | text |
3other output fields
Input fields[3]
| Field | Type |
|---|---|
Full Perms | boolean |
Document Type Id | choice |
Id In | choice |
Name Icontains | text |
Name Iendswith | text |
Name Iexact | text |
Name Istartswith | text |
Ordering | text |
1other input field
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Owner | number |
2other output fields
No fields documented.
Input fields[3]
| Field | Type |
|---|---|
Full Perms | boolean |
Storage Path Id | choice |
Id In | choice |
Name Icontains | text |
Name Iendswith | text |
Name Iexact | text |
Name Istartswith | text |
Ordering | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Path | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
2other output fields
Input fields[3]
| Field | Type |
|---|---|
Full Perms | boolean |
Tag Id | choice |
Id In | choice |
Is Root | boolean |
Name Icontains | text |
Name Iendswith | text |
Name Iexact | text |
Name Istartswith | text |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Color | text |
Text Color | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
6other output fields
Input fields[3]
| Field | Type |
|---|---|
Acknowledged | boolean |
Created After | date |
Created Before | date |
Is Complete | boolean |
Name | text |
Ordering | text |
Owner | choice |
Result | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Task Id | text |
Task Type | text |
Task Type Display | text |
Trigger Source | text |
Trigger Source Display | text |
Status | text |
Status Display | text |
10other output fields
Input fields[3]
| Field | Type |
|---|---|
Added Date Gt | date |
Added Date Gte | date |
Added Date Lt | date |
Added Date Lte | date |
Added Day | number |
Added Gt | text |
Added Gte | text |
Added Lt | text |
104other input fields
Output fields[3]
| Field | Type |
|---|---|
ID | number |
Correspondent | number |
Document type | number |
Storage path | number |
Title | text |
Content | text |
Tags | array |
Created | text |
17other output fields
Input fields[3]
| Field | Type |
|---|---|
SecretRequired | text |
CodeRequired | text |
Input fields[3]
| Field | Type |
|---|---|
Documents | choice |
All | boolean |
Filters | object |
Field | text |
Value | text |
Content | text |
Compression | text |
Follow Formatting | boolean |
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
MatchRequired | text |
Matching AlgorithmRequired | number |
Is InsensitiveRequired | boolean |
OwnerRequired | choice |
Set Permissions | object |
View Permissions | object |
Change Permissions | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Last Correspondence | text |
3other output fields
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
IMAP ServerRequired | text |
IMAP PortRequired | number |
IMAP SecurityRequired | choice |
UsernameRequired | text |
PasswordRequired | secret |
Character Set | text |
Is Token | boolean |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Imap Server | text |
Imap Port | number |
Imap Security | text |
Username | text |
Password | text |
Character Set | text |
5other output fields
Input fields[3]
| Field | Type |
|---|---|
Name | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Page Size | number |
Display Mode | text |
Display Fields | text |
Owner | choice |
1other input field
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Rule Type | text |
Value | text |
Page Size | number |
Display Mode | text |
Display Fields | text |
3other output fields
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
PathRequired | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Owner | choice |
Set Permissions | object |
View | object |
Change | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Path | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
2other output fields
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
Color | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Is Inbox Tag | boolean |
Owner | choice |
Set Permissions | object |
View | object |
Change | object |
1other input field
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Color | text |
Text Color | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
6other output fields
No fields documented.
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Version IdRequired | number |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | number |
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Follow Formatting | boolean |
Original | boolean |
Input fields[3]
| Field | Type |
|---|---|
Db Only | boolean |
QueryRequired | text |
Output fields[3]
| Field | Type |
|---|---|
Total | number |
Documents | array |
Id | number |
Correspondent | number |
Document Type | number |
Storage Path | number |
Title | text |
Content | text |
Tags | array |
Created | date |
Created Date | date |
Modified | date |
Saved Views | array |
Id | number |
Name | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Page Size | number |
Display Mode | text |
Display Fields | text |
Owner | number |
Permissions | object |
Tags | array |
Id | number |
Slug | text |
Name | text |
Color | text |
Text Color | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Is Inbox Tag | boolean |
Document Count | number |
Correspondents | array |
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Last Correspondence | date |
Owner | number |
Permissions | object |
Document Types | array |
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Owner | number |
Permissions | object |
User Can Change | boolean |
Storage Paths | array |
Id | number |
Slug | text |
Name | text |
Path | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Owner | number |
User Can Change | boolean |
Users | array |
Id | number |
Username | text |
Email | text |
Password | text |
First Name | text |
Last Name | text |
Date Joined | date |
Is Staff | boolean |
Is Active | boolean |
Is Superuser | boolean |
5other output fields
Input fields[3]
| Field | Type |
|---|---|
Config IdRequired | choice |
User Arguments | text |
Barcode Tag Mapping | text |
LLM API Key | text |
Output Type | choice |
Pages | number |
Language | text |
Mode | choice |
32other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
User Args | text |
Barcode Tag Mapping | text |
Llm Api Key | text |
Output Type | text |
Pages | number |
Language | text |
Mode | text |
32other output fields
Input fields[3]
| Field | Type |
|---|---|
Correspondent IdRequired | choice |
Name | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Owner | choice |
Set Permissions | object |
View | object |
Change | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Last Correspondence | text |
3other output fields
Input fields[3]
| Field | Type |
|---|---|
Document Type IdRequired | choice |
Name | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Owner | choice |
Set Permissions | object |
View Permissions | object |
Change Permissions | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Owner | number |
2other output fields
Input fields[3]
| Field | Type |
|---|---|
Mail Account IdRequired | choice |
Name | text |
IMAP Server | text |
IMAP Port | number |
IMAP Security | number |
Username | text |
Password | text |
Character Set | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Imap Server | text |
Imap Port | number |
Imap Security | text |
Username | text |
Password | text |
Character Set | text |
5other output fields
Input fields[3]
| Field | Type |
|---|---|
Mail Rule IdRequired | choice |
Name | text |
Account | number |
Enabled | boolean |
Folder | text |
Filter From | text |
Filter To | text |
Filter Subject | text |
19other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Account | number |
Enabled | boolean |
Folder | text |
Filter From | text |
Filter To | text |
Filter Subject | text |
19other output fields
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Page Size | number |
Display Mode | choice |
Display Fields | text |
Owner | choice |
1other input field
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Rule Type | text |
Value | text |
Page Size | number |
Display Mode | text |
Display Fields | text |
3other output fields
Input fields[3]
| Field | Type |
|---|---|
Storage Path IdRequired | choice |
Name | text |
Path | text |
Match | text |
Matching Algorithm | number |
Case Insensitive | boolean |
Owner | choice |
Set Permissions | object |
View Permissions | object |
Change Permissions | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Path | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
2other output fields
Input fields[3]
| Field | Type |
|---|---|
Tag IdRequired | choice |
Name | text |
Color | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Is Inbox Tag | boolean |
Owner | choice |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Color | text |
Text Color | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
6other output fields
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
Document IdRequired | choice |
CorrespondentRequired | number |
Document TypeRequired | choice |
Storage PathRequired | choice |
Title | text |
Content | text |
TagsRequired | array |
Created | date |
6other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Correspondent | number |
Document Type | number |
Storage Path | number |
Title | text |
Content | text |
Tags | array |
Created | date |
18other output fields
Input fields[3]
| Field | Type |
|---|---|
PathRequired | text |
DocumentRequired | choice |
Input fields[3]
| Field | Type |
|---|---|
Document IDRequired | choice |
Correspondent | choice |
Document Type | choice |
Storage Path | choice |
Title | text |
Content | text |
Tags | choice |
Created Date | date |
6other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Correspondent | number |
Document Type | number |
Storage Path | number |
Title | text |
Content | text |
Tags | array |
Created | date |
17other output fields
Input fields[3]
| Field | Type |
|---|---|
Config IdRequired | choice |
User Arguments | text |
Barcode Tag Mapping | text |
LLM API Key | text |
Output Type | choice |
Pages | number |
Language | text |
Mode | choice |
32other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
User Args | text |
Barcode Tag Mapping | text |
Llm Api Key | text |
Output Type | text |
Pages | number |
Language | text |
Mode | text |
32other output fields
Input fields[3]
| Field | Type |
|---|---|
Correspondent IdRequired | choice |
Name | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Owner | choice |
Set Permissions | object |
View | object |
Change | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Last Correspondence | text |
3other output fields
Input fields[3]
| Field | Type |
|---|---|
Document Type IdRequired | choice |
Name | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Owner | choice |
Set Permissions | object |
View | object |
Change | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
Owner | number |
2other output fields
Input fields[3]
| Field | Type |
|---|---|
Document IdRequired | choice |
DocumentRequired | text |
Version Label | text |
Input fields[3]
| Field | Type |
|---|---|
Mail Account IdRequired | choice |
Name | text |
IMAP Server | text |
IMAP Port | number |
IMAP Security | choice |
Username | text |
Password | text |
Character Set | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Imap Server | text |
Imap Port | number |
Imap Security | text |
Username | text |
Password | secret |
Character Set | text |
5other output fields
Input fields[3]
| Field | Type |
|---|---|
Mail Rule IdRequired | choice |
Name | text |
Account | number |
Enabled | boolean |
Folder | text |
Filter From | text |
Filter To | text |
Filter Subject | text |
19other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Account | number |
Enabled | boolean |
Folder | text |
Filter From | text |
Filter To | text |
Filter Subject | text |
19other output fields
Input fields[3]
| Field | Type |
|---|---|
Saved View IdRequired | choice |
Name | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Page Size | number |
Display Mode | text |
Display Fields | text |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Name | text |
Sort Field | text |
Sort Reverse | boolean |
Filter Rules | array |
Rule Type | text |
Value | text |
Page Size | number |
Display Mode | text |
Display Fields | text |
3other output fields
Input fields[3]
| Field | Type |
|---|---|
Storage Path IdRequired | choice |
Name | text |
Path | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Owner | choice |
Set Permissions | object |
View | object |
Change | object |
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Path | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
Document Count | number |
2other output fields
Input fields[3]
| Field | Type |
|---|---|
Tag IdRequired | choice |
Name | text |
Color | text |
Match | text |
Matching Algorithm | number |
Is Insensitive | boolean |
Is Inbox Tag | boolean |
Owner | choice |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
Id | number |
Slug | text |
Name | text |
Color | text |
Text Color | text |
Match | text |
Matching Algorithm | text |
Is Insensitive | boolean |
6other output fields
Input fields[3]
| Field | Type |
|---|---|
DocumentRequired | text |
FilenameRequired | text |
Title | text |
Created | date |
Correspondent ID | choice |
Document Type ID | choice |
Storage Path ID | choice |
Tags | choice |
3other input fields
Templates
Look for Paperless-ngx templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Formstack Documents[2]Document generation from templates, with data routes.
- KoBoToolboxManage KoBoToolbox projects, submissions, exports, hooks, and organizations.
- ONLYOFFICE DocsManage files, folders, sharing, and editing sessions on a self-hosted ONLYOFFICE Docs (Community Server) instance.
- NextcloudManage files, shares, users, and activity on your Nextcloud server.
- eSignatures.comSend and manage electronic signature contracts and templates.
References
- WEXTL® Paperless-ngx Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Paperless-ngx.
- WEXTL® visual workflow builder data.
Last updated: Sep 24, 2026 00:37