Paperless-ngx

App · 16 actions

File paperwork in Paperless-ngx: add documents from links or text, find them by their words, tag them, note on them and keep their details tidy. Start a workflow when a document is added.

Actions

ActionWhat it does
Add noteAdd a note to a document, shown beside it in Paperless.
Add tagPut a tag on a document.
Create tagMake a tag.
Delete documentMove a document to Paperless's trash, where it can be restored for 30 days by default.
Delete tagDelete a tag.
Get current userWho the connection acts as in Paperless.
Get documentGet a document's details and its full text, as Paperless read it.
Get upload statusCheck whether Paperless has finished reading a document you added, and get its number.
List correspondentsList every correspondent, the people and companies documents come from.
List document typesList every document type, such as Invoice or Contract.
List tagsList every tag, with how many documents have it.
Remove tagTake a tag off a document.
Save text as documentKeep words, such as an email or a form answer, as a document in Paperless.
Search documentsFind documents by words in their text, a tag, a correspondent or a type.
Update documentChange a document's title, correspondent, type, date or archive serial number.
Upload document from linkDownload a file, such as a PDF invoice, from a link and add it to Paperless.

Add note

Add a note to a document, shown beside it in Paperless.

Inputs

DocumentdocumenttextRequired
The document's number, from 'Search documents' or the trigger, or its link.
NotenotetextRequired
What to note, such as Paid on 3 November.

Outputs

document_idnumber
The document's number
notetext
The note added
notesnumber
How many notes it has now
Example output
{
  "document_id": 412,
  "note": "Paid on 3 November",
  "notes": 1
}

Add tag

Put a tag on a document.

Inputs

DocumentdocumenttextRequired
The document's number, from 'Search documents' or the trigger, or its link.
TagtagtextRequired
The tag.

Outputs

addedtext
When it was added to Paperless (ISO 8601)
archive_serial_numbernumber
Its archive serial number; 0 if none
contenttext
Its text, as Paperless read it; cut short in a search
correspondenttext
Who it's from
createdtext
The date on it (YYYY-MM-DD)
document_typetext
What kind of document it is
file_nametext
The name of the file it came from
idnumber
The document's number
linktext
A link to it in Paperless
notesnumber
How many notes it has
snippettext
In a search by words, where they matched
tag_idslist
Its tags, by number
tagslist
Its tags, by name
titletext
Its title
Example output
{
  "added": "2026-10-28T09:00:00.000000Z",
  "archive_serial_number": 0,
  "content": "City Power & Light. Amount due: $84.20 by 15 November 2026.",
  "correspondent": "City Power & Light",
  "created": "2026-10-21",
  "document_type": "Invoice",
  "file_name": "bill-2026-10.pdf",
  "id": 412,
  "link": "https://paperless.example.com/documents/412/details",
  "notes": 0,
  "snippet": "",
  "tag_ids": [
    3,
    7
  ],
  "tags": [
    "Bills",
    "To pay"
  ],
  "title": "Electricity bill October 2026"
}

Create tag

Make a tag. Paperless puts it only where you or a workflow add it.

Inputs

NamenametextRequired
What to call it, such as To pay.
Colourcolortext
Its colour, such as #a6cee3. Leave blank for Paperless to pick one.

Outputs

colortext
Its colour
document_countnumber
How many documents have it
idnumber
Its number
nametext
Its name
Example output
{
  "color": "#a6cee3",
  "document_count": 0,
  "id": 7,
  "name": "To pay"
}

Delete document

Move a document to Paperless's trash, where it can be restored for 30 days by default.

Inputs

DocumentdocumenttextRequired
The document's number, from 'Search documents' or the trigger, or its link.

Outputs

deletedtrue/false
True once deleted
idnumber
The document's number
Example output
{
  "deleted": true,
  "id": 412
}

Delete tag

Delete a tag. Documents that had it keep everything else.

Inputs

TagtagtextRequired
The tag.

Outputs

deletedtrue/false
True once deleted
idnumber
The tag's number
Example output
{
  "deleted": true,
  "id": 7
}

Get current user

Who the connection acts as in Paperless.

Inputs

None.

Outputs

idnumber
The user's number
is_superusertrue/false
Whether they're a Paperless administrator
nametext
Their name
usernametext
Their username
Example output
{
  "id": 1,
  "is_superuser": false,
  "name": "Ada Lovelace",
  "username": "ada"
}

Get document

Get a document's details and its full text, as Paperless read it.

Inputs

DocumentdocumenttextRequired
The document's number, from 'Search documents' or the trigger, or its link.

Outputs

addedtext
When it was added to Paperless (ISO 8601)
archive_serial_numbernumber
Its archive serial number; 0 if none
contenttext
Its text, as Paperless read it; cut short in a search
correspondenttext
Who it's from
createdtext
The date on it (YYYY-MM-DD)
document_typetext
What kind of document it is
file_nametext
The name of the file it came from
idnumber
The document's number
linktext
A link to it in Paperless
notesnumber
How many notes it has
snippettext
In a search by words, where they matched
tag_idslist
Its tags, by number
tagslist
Its tags, by name
titletext
Its title
Example output
{
  "added": "2026-10-28T09:00:00.000000Z",
  "archive_serial_number": 0,
  "content": "City Power & Light. Amount due: $84.20 by 15 November 2026.",
  "correspondent": "City Power & Light",
  "created": "2026-10-21",
  "document_type": "Invoice",
  "file_name": "bill-2026-10.pdf",
  "id": 412,
  "link": "https://paperless.example.com/documents/412/details",
  "notes": 0,
  "snippet": "",
  "tag_ids": [
    3,
    7
  ],
  "tags": [
    "Bills",
    "To pay"
  ],
  "title": "Electricity bill October 2026"
}

Get upload status

Check whether Paperless has finished reading a document you added, and get its number.

Inputs

Task IDtask_idtextRequired
The task ID an add action returned.

Outputs

document_idnumber
The new document's number, once added; 0 before
linktext
A link to the new document, once added
messagetext
What Paperless said about the add
statustext
added, queued (still being read) or failed
task_idtext
Paperless's task ID for the add
Example output
{
  "document_id": 412,
  "link": "https://paperless.example.com/documents/412/details",
  "message": "Success. New document id 412 created",
  "status": "added",
  "task_id": "6f1d3c1e-58a1-4c87-9a4b-2f5e1c9d7b20"
}

List correspondents

List every correspondent, the people and companies documents come from.

Inputs

None.

Outputs

correspondentslist
The correspondents
countnumber
How many
Example output
{
  "correspondents": [
    {
      "document_count": 18,
      "id": 5,
      "name": "City Power & Light"
    }
  ],
  "count": 1
}

List document types

List every document type, such as Invoice or Contract.

Inputs

None.

Outputs

countnumber
How many
document_typeslist
The document types
Example output
{
  "count": 1,
  "document_types": [
    {
      "document_count": 96,
      "id": 2,
      "name": "Invoice"
    }
  ]
}

List tags

List every tag, with how many documents have it.

Inputs

None.

Outputs

countnumber
How many
tagslist
The tags
Example output
{
  "count": 1,
  "tags": [
    {
      "color": "#a6cee3",
      "document_count": 41,
      "id": 3,
      "name": "Bills"
    }
  ]
}

Remove tag

Take a tag off a document.

Inputs

DocumentdocumenttextRequired
The document's number, from 'Search documents' or the trigger, or its link.
TagtagtextRequired
The tag.

Outputs

addedtext
When it was added to Paperless (ISO 8601)
archive_serial_numbernumber
Its archive serial number; 0 if none
contenttext
Its text, as Paperless read it; cut short in a search
correspondenttext
Who it's from
createdtext
The date on it (YYYY-MM-DD)
document_typetext
What kind of document it is
file_nametext
The name of the file it came from
idnumber
The document's number
linktext
A link to it in Paperless
notesnumber
How many notes it has
snippettext
In a search by words, where they matched
tag_idslist
Its tags, by number
tagslist
Its tags, by name
titletext
Its title
Example output
{
  "added": "2026-10-28T09:00:00.000000Z",
  "archive_serial_number": 0,
  "content": "City Power & Light. Amount due: $84.20 by 15 November 2026.",
  "correspondent": "City Power & Light",
  "created": "2026-10-21",
  "document_type": "Invoice",
  "file_name": "bill-2026-10.pdf",
  "id": 412,
  "link": "https://paperless.example.com/documents/412/details",
  "notes": 0,
  "snippet": "",
  "tag_ids": [
    3
  ],
  "tags": [
    "Bills"
  ],
  "title": "Electricity bill October 2026"
}

Save text as document

Keep words, such as an email or a form answer, as a document in Paperless.

Inputs

TitletitletextRequired
The document's title.
TexttexttextRequired
What the document says.
Datecreateddate
The date on the document. Leave blank to let Paperless find it.
Correspondentcorrespondenttext
Who it's from. Leave blank to let Paperless match one.
Document typedocument_typetext
What kind of document it is. Leave blank to let Paperless match one.
Tagstagslist
Tags to put on it, besides any Paperless matches.

Outputs

document_idnumber
The new document's number, once added; 0 before
linktext
A link to the new document, once added
messagetext
What Paperless said about the add
statustext
added, queued (still being read) or failed
task_idtext
Paperless's task ID for the add
Example output
{
  "document_id": 412,
  "link": "https://paperless.example.com/documents/412/details",
  "message": "Success. New document id 412 created",
  "status": "added",
  "task_id": "6f1d3c1e-58a1-4c87-9a4b-2f5e1c9d7b20"
}

Search documents

Find documents by words in their text, a tag, a correspondent or a type. Newest first unless searching by words.

Inputs

Wordsquerytext
Words to look for in the documents' text and titles. Leave blank to list the newest.
Tagtagtext
Only documents with this tag.
Correspondentcorrespondenttext
Only documents from this correspondent.
Document typedocument_typetext
Only documents of this type.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
documentslist
The documents found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "documents": [
    {
      "added": "2026-10-28T09:00:00.000000Z",
      "archive_serial_number": 0,
      "content": "City Power & Light. Amount due: $84.20 by 15 November 2026.",
      "correspondent": "City Power & Light",
      "created": "2026-10-21",
      "document_type": "Invoice",
      "file_name": "bill-2026-10.pdf",
      "id": 412,
      "link": "https://paperless.example.com/documents/412/details",
      "notes": 0,
      "snippet": "",
      "tag_ids": [
        3,
        7
      ],
      "tags": [
        "Bills",
        "To pay"
      ],
      "title": "Electricity bill October 2026"
    }
  ],
  "total": 1
}

Update document

Change a document's title, correspondent, type, date or archive serial number.

Inputs

DocumentdocumenttextRequired
The document's number, from 'Search documents' or the trigger, or its link.
Titletitletext
A new title. Leave blank to keep it.
Correspondentcorrespondenttext
Who it's from. Leave blank to keep it.
Document typedocument_typetext
What kind of document it is. Leave blank to keep it.
Datecreateddate
The date on the document. Leave blank to keep it.
Archive serial numberarchive_serial_numbernumber
The number on the paper original's label. Leave blank to keep it.At least 0.

Outputs

addedtext
When it was added to Paperless (ISO 8601)
archive_serial_numbernumber
Its archive serial number; 0 if none
contenttext
Its text, as Paperless read it; cut short in a search
correspondenttext
Who it's from
createdtext
The date on it (YYYY-MM-DD)
document_typetext
What kind of document it is
file_nametext
The name of the file it came from
idnumber
The document's number
linktext
A link to it in Paperless
notesnumber
How many notes it has
snippettext
In a search by words, where they matched
tag_idslist
Its tags, by number
tagslist
Its tags, by name
titletext
Its title
Example output
{
  "added": "2026-10-28T09:00:00.000000Z",
  "archive_serial_number": 0,
  "content": "City Power & Light. Amount due: $84.20 by 15 November 2026.",
  "correspondent": "City Power & Light",
  "created": "2026-10-21",
  "document_type": "Invoice",
  "file_name": "bill-2026-10.pdf",
  "id": 412,
  "link": "https://paperless.example.com/documents/412/details",
  "notes": 0,
  "snippet": "",
  "tag_ids": [
    3,
    7
  ],
  "tags": [
    "Bills",
    "To pay"
  ],
  "title": "Electricity bill October 2026"
}

Download a file, such as a PDF invoice, from a link and add it to Paperless.

Inputs

LinkurltextRequired
A link anyone can download the file from, starting with https://.
Titletitletext
The document's title. Leave blank to use the file's name.
Datecreateddate
The date on the document. Leave blank to let Paperless find it.
Correspondentcorrespondenttext
Who it's from. Leave blank to let Paperless match one.
Document typedocument_typetext
What kind of document it is. Leave blank to let Paperless match one.
Tagstagslist
Tags to put on it, besides any Paperless matches.

Outputs

document_idnumber
The new document's number, once added; 0 before
linktext
A link to the new document, once added
messagetext
What Paperless said about the add
statustext
added, queued (still being read) or failed
task_idtext
Paperless's task ID for the add
Example output
{
  "document_id": 412,
  "link": "https://paperless.example.com/documents/412/details",
  "message": "Success. New document id 412 created",
  "status": "added",
  "task_id": "6f1d3c1e-58a1-4c87-9a4b-2f5e1c9d7b20"
}

On this page