List background tasks
list_tasksList Paperless-ngx background tasks to inspect their status, result, and created document ID, with filters for status, task ID, acknowledgment, and more.
Instructions
Background tasks — consumption, merges, reprocessing — with their state and result. This is where an upload's outcome shows up, including the ID of the document it created.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_tasks"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| full | No | Return every field instead of the identifying summary. | |
| page | No | 1-based page number. | |
| status | No | Paperless reports these lower-case; 'success' and 'failure' are the interesting ones. | |
| task_id | No | Filter to one task UUID, e.g. the one upload_document returned. | |
| ordering | No | Field to order by. Prefix with '-' to reverse, e.g. '-created'. | |
| page_size | No | Items per page. Clamped by the server's configured ceiling. | |
| acknowledged | No | false shows only tasks the user has not dismissed. | |
| name__icontains | No | Case-insensitive substring filter on the name. |