Bitrix24 icon

Bitrix24

Interact with Bitrix24 — CRM, Tasks, Open Channels, Chatbots, Drive, Documents, News Feed and Raw API

Actions29

Lead → Search

AI-generated

Summary

Search Leads in Bitrix24 CRM applying multiple optional filters on standard and custom fields, returning up to a specified number of matching Lead records.

Inputs

  • Authentication (required) — Choose between 'Webhook' or 'OAuth2' authentication methods.
  • Category (required) — Select the Bitrix24 integration category; defaults to 'CRM'.
  • Filters — Set one or more filters on standard Lead properties including Title, Name, Phone, Email, Source, Status, Responsible User, Converted status, and creation date range; all filters combine with AND logic.
  • Custom Field Filters — Add one or more custom field filters by specifying the Lead custom field name and desired value, allowing fine-grained Lead search criteria.
  • Max Results — Define the maximum number of Leads to return; set to 0 to fetch all matching Leads.

Output shape

a list of Lead records matching the specified filters

The output will include Leads found based on the combined standard and custom field filters, limited by Max Results. The operation supports pagination internally if needed to retrieve all records when Max Results is set to 0.

Examples

Example 1: Find Leads with a specific email and status

Set Email filter to the desired email address, Status filter to a specific lead status, and Max Results to limit the output count.

Example 2: Retrieve all converted Leads assigned to a particular user

Use Converted status filter set to 'Yes', Responsible User filter with the target user's ID, and set Max Results to 0 to fetch all matches.

Links

Discussion