List customers
list_customersFetch customer records page by page, newest first, to locate a customer ID without filters. Continue paging until a page returns fewer rows than requested.
Instructions
List customers, most recently updated first, one page at a time. Use it to browse the roster or to find an Id when you have nothing to filter on; prefer search_customers when you do. Read-only. Paging is caller-driven through start_position and max_results, and the result reports how many rows came back, so keep requesting pages until fewer than max_results rows are returned. Both active and inactive customers are included.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_results | No | Maximum rows to return in this page, between 1 and 1000. QuickBooks serves at most 1000 rows per query, so larger result sets need several calls. | |
| start_position | No | One-based index of the first row to return. Page by adding max_results to it: with max_results 20, the second page starts at 21. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| count | No | ||
| error | No | ||
| customers | No | ||
| max_results | No | ||
| start_position | No |