Trash

The trash resource exposes documents that have been soft-deleted in Paperless-ngx. Trashed documents can be restored or permanently deleted. The service iterates over Document objects just like the main documents service.

Model

Trashed documents use the same Document model — see pypaperless/models/documents.py. In the trash context, deleted_at is additionally populated with the timestamp when the document was moved to the trash.

Iterate

async for doc in paperless.trash:
    print(doc.id, doc.title, doc.deleted_at)

# Collect all trashed documents as a list
trashed = await paperless.trash.as_list()
print(f"{len(trashed)} document(s) in trash")

Filter

# Trashed documents matching a title substring
async for doc in paperless.trash.filter(title__icontains="invoice"):
    print(doc.id, doc.title)

filter() accepts the same parameters as paperless.documents.filter(). See Documents for available parameters.

Restore

Restore one or more documents back to the document archive:

await paperless.trash.restore([42, 43])

Empty

Permanently delete documents from the trash. Pass a list of IDs to delete specific documents, or call without arguments to empty the entire trash:

# Delete specific documents permanently
await paperless.trash.empty([42, 43])

# Empty the entire trash
await paperless.trash.empty()