Find customers
find_customersSearch customers by partial name, email, or phone. Pages through the customer list because no search API exists; optionally include contact details.
Instructions
Search customers by part of their name, email, mobile or phone (UK numbers match with 0 or +44). The API has no search parameter, so this pages through the customer list (100 per call) up to max_pages. Names only by default; contact details with include_contact_details. Note that a match on an email or phone fragment still confirms that such a detail exists on the account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Name, email or phone fragment | |
| max_pages | No | Pages of 100 customers to scan | |
| max_results | No | ||
| include_contact_details | No | Include each match's email, mobile, phone, address and gender, and custom fields that look like contact data |