search_leads
Search and filter leads using customizable criteria like name, country, source, and date. Specify fields, operators, and values to find specific leads in Kylas CRM.
Instructions
Search/filter leads. Only fields marked [FILTERABLE] in get_lead_field_instructions can be used. Call get_lead_field_instructions first to get filterable fields and their types.
filters: List of filter objects. Each must have:
field (str): Field internal/API name (e.g. firstName, country, source, createdAt).
operator (str): One of the allowed operators for that field type (e.g. equal, contains, greater).
value: Value to compare. For PICK_LIST/MULTI_PICKLIST use Option ID (number), except requirementCurrency, companyBusinessType, country, timezone, companyIndustry — use internal name (string). For date/datetime (incl. custom e.g. cfDateField): value null for today/is_null/is_not_null; single ISO string for greater/greater_or_equal/less/less_or_equal e.g. "2026-02-02T18:30:00.000Z"; for between use [startISO, endISO].
timeZone (str, optional): For date/datetime filters only; default from server or env.
type (str, optional): Field type from cheat sheet. If omitted, inferred from schema. For user look-up fields (createdBy, updatedBy, convertedBy, ownerId, importedBy): value must be user ID (number). Call lookup_users first. For the products field: value must be product ID (number). Call lookup_products first; if multiple matches, ask which product, then use that ID here. For pipeline / pipelineStage (e.g. open leads, closed leads): call lookup_pipelines first, ask the user to confirm which pipeline, then call get_pipeline_stages for that pipeline only; if stage is ambiguous ask which stage, then use pipeline + pipelineStage filters here. page: 0-based page (default 0). size: Page size, max 100 (default 20). sort: Sort e.g. "createdAt,desc" (default).
Operators by type (examples): TEXT_FIELD: equal, contains, is_empty. NUMBER: equal, greater, between, is_null. PICK_LIST: equal, in, is_null. DATETIME_PICKER: today, yesterday, between, is_not_null, greater, less, current_week, etc.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters | Yes | ||
| page | No | ||
| size | No | ||
| sort | No | createdAt,desc |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |