leads_search
Search leads by title, notes, and custom fields using a search term. Filter results by person or organization for targeted lead queries.
Instructions
Search leads by title, notes, and custom fields.
Searches all leads by title, notes, and/or custom fields using a search term. This is a wrapper of /v1/itemSearch with a narrower OAuth scope.
Workflow tips:
Minimum 2 characters for search term (or 1 with exact_match)
Use exact_match for case-insensitive exact matching
Filter results by person_id or organization_id (max 2000 leads each)
fields parameter specifies which fields to search (comma-separated)
Results include result_score for relevance ranking
Use start/limit for pagination
Common use cases:
Search by title: { "term": "acme" }
Exact match: { "term": "Acme Corp", "exact_match": true }
Search for person's leads: { "term": "deal", "person_id": 123 }
Search org's leads: { "term": "proposal", "organization_id": 456 }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| term | Yes | Search term (min 2 chars, or 1 with exact_match) | |
| limit | No | Items shown per page (max 500) | |
| start | No | Pagination start | |
| fields | No | Comma-separated fields to search (defaults to all) | |
| person_id | No | Filter by person ID (max 2000 leads) | |
| exact_match | No | Enable exact match search (case insensitive) | |
| include_fields | No | Comma-separated optional fields to include | |
| organization_id | No | Filter by organization ID (max 2000 leads) |