Search Customers Tool
search-customersSearches the authenticated workspace customers without exposing addresses, notes, or other private fields. Use to search customers in the connected business. Returns query, count, customers, id, name, email, phone, business_name, trade_type, lifecycle_tag, scope.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "search-customers"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of customers to return. | |
| query | No | Name, email, phone, or business name to search for. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Number of customers returned in this bounded result. | |
| query | Yes | Search text, or null when no query was supplied. | |
| scope | Yes | Results belong to the business bound to this OAuth connection. | |
| customers | Yes | Safe customer contact and lifecycle fields; excludes addresses and notes. |