Wave: List Customers
wave_list_customersList customers with outstanding and overdue balances. Supports filtering by exact email or partial name, pagination, and sorting.
Instructions
List customers, with each one's outstanding and overdue balance. Wave can filter by exact email only; name_contains is applied by this server after fetching, so combine it with fetch_all=true when searching a large customer list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number for offset pagination. | |
| sort | No | NAME_ASC, NAME_DESC, CREATED_AT_ASC/DESC, MODIFIED_AT_ASC/DESC. Defaults to NAME_ASC. | |
| No | Exact email match, applied by Wave. | ||
| fetch_all | No | Walk every page instead of returning just one. Slower, but complete. | |
| page_size | No | Records per page (1-200). | |
| business_id | No | Business to operate on. Defaults to the session business set by wave_set_default_business. | |
| name_contains | No | Case-insensitive substring match on name, applied locally. | |
| modified_after | No | ISO 8601 timestamp; only customers changed after it. | |
| modified_before | No | ISO 8601 timestamp; only customers changed before it. | |
| response_format | No | Output format: "markdown" for a compact human-readable summary, "json" for the complete record. | markdown |