list_customers
Read-only
Retrieve customers, optionally filtered by service organization. Supports pagination and CSV output for analysis.
Instructions
Retrieve a list of customers. If soId is provided, returns only customers under that service organization; otherwise returns all customers. Returns one page by default — set all: true to auto-paginate. Use format: "csv" for spreadsheet-ready output.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| soId | No | Optional service organization ID to filter customers by SO | |
| pageNumber | No | Page number (starts at 1) | |
| pageSize | No | Number of items per page (max 200) | |
| select | No | Filter expression (FIQL/RSQL predicate) — despite the "select" name, this filters rows, it does NOT pick fields. Syntax: `field==value`, join predicates with `;` for AND. Example: `soId==50` returns only the SO with that ID. Not all fields are queryable; unsupported ones error with "Field not found: X". | |
| sortBy | No | Field to sort results by | |
| sortOrder | No | Sort order: ASC, asc, ascending, natural, desc, descending, reverse | |
| all | No | Auto-paginate: fetch every page and return the combined list. Ignores pageNumber/pageSize. Use for complete results; omit to return a single page (cheaper, safer for large environments). | |
| format | No | Output format: "csv" or "json". Default varies by tool — list_* default to json; report_* default to csv. |