Bitrix24 icon

Bitrix24

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

Actions29

Contact → Search

AI-generated

Summary

Search Bitrix24 CRM contacts using filter criteria such as name, phone, email, company ID, source, responsible user, creation date range, and custom fields, returning a list of matching contacts.

Inputs

  • authentication — Choose the authentication method for Bitrix24 API requests: either 'Webhook' for inbound webhook URL access or 'OAuth2' for local Bitrix24 apps.
  • category — Specify the Bitrix24 API category, defaulting to 'crm' for this operation.
  • searchFilters — Filter contacts by one or multiple fields that all combine with AND logic. Supports filtering by partial name or last name, phone, email, company ID, source ID, responsible user, and created date range.
  • searchCustomFields — Apply custom field filters on contacts by specifying field name (from available Bitrix24 contact custom fields) and value, supporting multiple custom field filters combined with AND logic.
  • searchLimit — Limit the maximum number of search results returned. Setting to 0 fetches all matching records.

Output shape

a list of contact objects matching the specified filters

The result includes standard and custom contact fields. Pagination is internally handled by the node according to the 'searchLimit' parameter; setting this to 0 returns all matching contacts without limit.

Examples

Example 1: Find all contacts created after January 1, 2023, with 'Smith' in the last name, limited to 10 results.

Set 'Last Name (contains)' to 'Smith', 'Created After' to '2023-01-01T00:00:00.000Z', and 'Max Results' to 10.

Example 2: Search for contacts with a specific custom field value.

Add a Custom Field Filter by selecting the field name and specifying the desired value.

Links

Discussion