Saved Views

Saved views are named document filter presets that can be pinned to the dashboard or sidebar in the Paperless-ngx web UI. They support fetching and iterating, with permission information available on request.

Model

See pypaperless/models/saved_views.py for all fields and pypaperless/models/types.py for enum and filter types, and the Paperless-ngx API docs for the upstream schema.

Fetch one

view = await paperless.saved_views(2)
print(view.name)               # "Inbox"
print(view.show_on_dashboard)  # True
print(view.filter_rules)       # [SavedViewFilterRule(...), ...]

Iterate

async for view in paperless.saved_views:
    print(view.id, view.name)

# Only views shown in the sidebar
sidebar_views = [
    v async for v in paperless.saved_views
    if v.show_in_sidebar
]

Permissions

async with paperless.saved_views.with_permissions():
    view = await paperless.saved_views(2)
    print(view.owner)        # owner user id
    print(view.permissions)  # Permissions

See Permissions for details.