List tags, correspondents and other objects
paperless_list_objectsList archive objects like tags, correspondents, custom fields, saved views, users, and workflows with their IDs and document counts to supply required IDs for document operations.
Instructions
List the objects documents are filed under, with their ids and document counts. Call this first when you need an id for a tag, correspondent, document type, storage path or custom field — the document tools take ids, not names. Also reaches saved views, users, groups, mail accounts, mail rules, workflows and share links.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| type | Yes | Which collection to list. | |
| ordering | No | Sort field, `-` prefix for descending, e.g. `name`, `-document_count`. | |
| all_pages | No | Fetch every page (capped at 1000 objects) instead of a single page. | |
| page_size | No | ||
| name_contains | No | Case-insensitive substring filter on the name (username, for `users`). |