List correspondents
list_correspondentsList correspondents—the people and organizations documents are from or to—and return their IDs for filtering document searches by correspondent_id.
Instructions
List correspondents: the people and organizations that documents are from or to.
Use the returned IDs with search_documents(correspondent_id=...).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Return only the correspondents with these IDs (default: none) | |
| page | No | Page number, starting at 1 (default: 1) | |
| page_size | No | Number of correspondents per page (default: 100) | |
| name_contains | No | Case-insensitive substring of the name (default: none) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pagination | Yes | The position of one page of results in the full result set. | |
| correspondents | Yes |