Resources

Every Paperless-ngx entity is exposed through a service on the PaperlessClient instance. Each service supports a consistent set of operations - fetch, iterate, create, update or delete.

Capability matrix

Fetching a single item

Call the service with a primary key to retrieve one item:

document = await paperless.documents(42)
correspondent = await paperless.correspondents(7)
tag = await paperless.tags(3)

Lazy loading

Pass lazy=True to create a model instance without making any HTTP request. Useful when you only need the primary key reference:

doc = await paperless.documents(42, lazy=True)
# doc.id == 42, but no data was fetched

Iterating over all items

Use async for to iterate over every item in a resource. pypaperless handles pagination automatically:

async for correspondent in paperless.correspondents:
    print(correspondent.id, correspondent.name)

async for tag in paperless.tags:
    print(tag.name, tag.color)

Getting all primary keys

To retrieve a flat list of all primary keys without fetching full model data:

all_ids: list[int] = await paperless.documents.all()

Pagination

You can iterate page-by-page instead of item-by-item. Page objects provide metadata about the current page:

async for page in paperless.documents.pages():
    print(f"Page {page.current_page} of {page.last_page} ({page.count} total)")
    for doc in page:
        print(doc.title)

Control the starting page and page size:

async for page in paperless.documents.pages(page=3, page_size=25):
    ...

Filtering with filter()

filter() is an async context manager that applies server-side filters to iteration. Filter keys are fully type-checked - your IDE will autocomplete available parameters and flag unknown keys.

Each service exposes its own typed filter set (e.g. DocumentFilters, TagFilters). Import them from pypaperless.models.filters to construct the dict separately:

from pypaperless.models.filters import DocumentFilters

filters: DocumentFilters = {
    "correspondent__id": 3,
    "title__icontains": "invoice",
}

async with paperless.documents.filter(**filters) as ctx:
    async for document in ctx:
        ...

You can also pass filters directly as keyword arguments:

async with paperless.documents.filter(title__icontains="invoice") as ctx:
    async for document in ctx:
        print(document.title)

The filter context is automatically cleared when the async with block exits.

Creating items

Use draft() to create a new draft model and save() to persist it:

# Create a new tag
draft = paperless.tags.create(name="important", color="#ff0000")
new_id = await paperless.tags.save(draft)
print(f"Created tag with id {new_id}")

# Create a new correspondent
draft = paperless.correspondents.create(name="ACME Corp")
new_id = await paperless.correspondents.save(draft)

You can also save via the client-level dispatcher — no need to know which service owns the draft:

new_id = await paperless.save(draft)

For required fields, see the model reference in the source code. If required fields are missing, DraftFieldRequiredError is raised.

Updating items

Modify fields on a fetched model and call update():

tag = await paperless.tags(3)
tag.name = "urgent"
tag.color = "#ff0000"

updated = await paperless.tags.update(tag)
print(f"Updated: {updated}")  # True if any field changed

update() returns True if any field was changed and sent to the API, False if no fields differed from the stored state. The model is refreshed in-place after a successful update.

By default, only changed fields are sent via PATCH. Pass only_changed=False to replace all fields via PUT:

await paperless.tags.update(tag, only_changed=False)

You can also update via the client-level dispatcher:

await paperless.update(tag)

Deleting items

tag = await paperless.tags(3)
await paperless.tags.delete(tag)

delete() raises DeletionError when the deletion fails. To silently ignore a failed deletion, pass silent_fail=True:

await paperless.tags.delete(tag, silent_fail=True)

You can also delete via the client-level dispatcher:

await paperless.delete(tag)

Model fields: matching & algorithms

Resources like Correspondent, Tag, DocumentType and StoragePath include matching fields inherited from MatchingFieldsModel:

MatchingAlgorithm values: