Paperless-ngx

Storage & databasesCredentials form

Search, read, upload, tag and annotate documents in a self-hosted Paperless-ngx archive.

12 actions

ActionEffectData handledScope
paperless_ngx_search_documentsFinds documents by full-text query, title, tags, correspondent, type or dates, or documents similar to onereadPersonal data
paperless_ngx_get_documentReads a document's metadata and its full extracted text contentreadPersonal data
paperless_ngx_update_documentChanges a document's title, date, correspondent, type, storage path, archive number or tagswritePersonal data
paperless_ngx_delete_documentDeletes a document; recent versions move it to the trash, where it can be restored until the trash is emptieddestructiveGeneral
paperless_ngx_upload_documentUploads a file for Paperless-ngx to consume, with optional title, date, correspondent, type and tagswritePersonal data
paperless_ngx_get_taskReads a consumption task by the id upload_document returned: its status, result and the created document idreadGeneral
paperless_ngx_list_notesLists the notes on a document with their authors and datesreadPersonal data
paperless_ngx_add_noteAdds a note to a documentwritePersonal data
paperless_ngx_list_tagsLists tags with their ids, colors and document counts, optionally by namereadGeneral
paperless_ngx_create_tagCreates a tag, optionally with a colorwriteGeneral
paperless_ngx_list_correspondentsLists correspondents (senders) with their ids and document counts, optionally by namereadGeneral
paperless_ngx_list_document_typesLists document types such as Invoice or Contract with their idsreadGeneral