list_correspondents
Retrieve and filter correspondents from your Paperless-NGX instance by name, paginate results, and order entries with customizable queries.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name__icontains | No | ||
| name__iendswith | No | ||
| name__iexact | No | ||
| name__istartswith | No | ||
| ordering | No | ||
| page | No | ||
| page_size | No |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"name__icontains": {
"type": "string"
},
"name__iendswith": {
"type": "string"
},
"name__iexact": {
"type": "string"
},
"name__istartswith": {
"type": "string"
},
"ordering": {
"type": "string"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
}
},
"type": "object"
}