search_persons
Search for persons by name, email, or phone with filters for organization and exact match. Specify search fields and limit response data for efficient retrieval.
Instructions
Search for persons with advanced filtering options.
Performs a person-specific search with additional filtering by organization.
Workflow tips:
Search term must be at least 2 characters
Filter by org_id to find persons in specific organizations
Specify fields to search: name, email, phone, custom fields
Use include_fields to limit response data
Use exact_match for precise searches
Results ordered by relevance
Common use cases:
Search by name: { "term": "john smith" }
Search by email: { "term": "john@example.com", "fields": "email" }
Search in organization: { "term": "smith", "org_id": 123 }
Search phone numbers: { "term": "+1234567890", "fields": "phone" }
Limit response: { "term": "john", "include_fields": "name,email,phone" }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| term | Yes | Search term (min 2 chars) | |
| fields | No | Comma-separated field names to search | |
| exact_match | No | Perform exact match search | |
| org_id | No | Filter by associated organization ID | |
| include_fields | No | Comma-separated fields to include in response | |
| start | No | Pagination start | |
| limit | No | Number of items to return |