list_correspondents
List all correspondents from Paperless-NGX with optional name filters and pagination to find entities sending or receiving documents.
Instructions
List all correspondents with optional filtering and pagination. Correspondents represent entities that send or receive documents.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-based) | |
| is_empty | No | Filter to only correspondents with 0 documents (true) or only those with >=1 document (false). Paginates through all results so the filter is global, not page-scoped. | |
| ordering | No | ||
| page_size | No | Number of items per page | |
| name__iexact | No | ||
| name__icontains | No | ||
| name__iendswith | No | ||
| name__istartswith | No |