search_customers
Discover customer IDs by filtering on name, address, phone, and more. Use returned IDs with get_customers to fetch complete customer records.
Instructions
Search for customers and return matching IDs (use get_customers to fetch full records). Maps to POST /customer/search. [tier: readonly-owner]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zip | No | ||
| city | No | ||
| fname | No | ||
| lname | No | ||
| phone | No | Matches phone1, phone2, or additional contact phone | |
| state | No | ||
| active | No | 1: active, 0: inactive | |
| address | No | ||
| officeIDs | No | ||
| customerIDs | No | ||
| includeData | No | Send 1 to also return resolved records for the first 1000 matches | |
| dateAddedEnd | No | ||
| extra_filters | No | Advanced filters on any other field, e.g. {"balanceAge": {"operator": ">", "value": 30}} | |
| dateAddedStart | No | ||
| dateUpdatedEnd | No | ||
| dateUpdatedStart | No |