Lead → Search
AI-generatedSummary
Search for leads in the Kylas database using specified filters and options.
Inputs
- limit — Max number of results to return (default: 50, range: 1-50).
- showAdvancedOptions — Whether to show advanced filtering and field selection options.
- fields — Comma-separated list of fields to return. Leave empty to return all fields (only applicable when advanced options are enabled).
- jsonRule — JSON rule object for filtering leads with complex AND conditions. Supports various operators and field types (only applicable when advanced options are enabled).
Output shape
a list of matching leads
Returns a list of leads that match the search criteria. If no matches are found, an empty array is returned. Filtering and field selection is only applied if advanced options are enabled.
Examples
Example 1: Basic Search
Search leads with all default fields and a maximum of 50 results.
Example 2: Filtered Search
Search leads using advanced options, returning specific fields such as 'id' and 'name', and applying a filter for leads with 'firstName' containing 'John'.