list_customers
List customers with filtering, sorting, and pagination. Retrieve records by account number, status, state, or date range, and include related locations or contacts.
Instructions
List customers with optional filtering, sorting and pagination. Maps to GET /customers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Prefix a field with - for descending order | |
| limit | No | Default 20 | |
| state | No | Record state, distinct from business status | |
| offset | No | ||
| status | No | ||
| include | No | ||
| created_after | No | ISO 8601 timestamp — maps to created[gt] | |
| updated_after | No | ISO 8601 timestamp — maps to updated[gt] | |
| account_number | No | ||
| created_before | No | ISO 8601 timestamp — maps to created[lt] | |
| updated_before | No | ISO 8601 timestamp — maps to updated[lt] |