List contacts
list-contactsList contacts with optional filters (name, fax_number, groups, note), pagination, sorting, and shared/personal filter. Use name=Jane (or fax_number=...) to filter; do not list everything and filter client-side. When sending a fax, always call this after pipeline_start and list-numbers (optional pipeline_id; use limit 20) before request-file-from-user. Do not ask the user for a contact. Response groups are group names (API stores IDs; this tool resolves them).
Side effects: none (read-only).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Optional list of contact IDs (max 50). When set, other filters are ignored. | |
| name | No | Filter contacts by name (e.g. Jane). | |
| note | No | Filter contacts by note/comment. | |
| sort | No | Sort by: name, creation_date, modification_date. | |
| limit | No | Page size 1..50 (default 20). | |
| groups | No | Filter contacts by group name. | |
| offset | No | Pagination offset (default 0). | |
| shared | No | If true: shared/corporate contacts; if false: personal contacts. | |
| direction | No | Sort direction: asc or desc. | |
| fax_number | No | Filter contacts by fax number. | |
| pipeline_id | No | Returned by pipeline_start. Pass it back unchanged. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| records | No | ||
| total_count | No |