Search Leads Tool
search-leadsSearches authorized workspace leads with bounded contact, source, status, and service-interest fields; notes and estimated values are excluded. Use to search leads in the connected business. Returns query, count, leads, 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-leads"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of leads to return. | |
| query | No | Name, email, phone, source, or service interest. | |
| source | No | Optional exact lead source. | |
| status | No | Optional lead status. | |
| urgency | No | Optional urgency: low, medium, or high. | |
| customer_id | No | Restrict results to a customer ID. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Count for the returned result. | |
| leads | Yes | Bounded leads records returned by this tool. | |
| query | Yes | Query used or returned by this tool. | |
| scope | Yes | Authorization scope of this result; data remains restricted to the connected business. |