Bitrix24 icon

Bitrix24

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

Actions29

Deal → Search

AI-generated

Summary

Search deals in Bitrix24 CRM using various filters including title, pipeline category, stage, responsible user, contact ID, company ID, close status, and custom fields, and retrieve matching deal records up to an optional maximum limit.

Inputs

  • Authentication — Select the authentication method to use: either a Bitrix24 inbound webhook URL or OAuth2 for local Bitrix24 apps.
  • Category — Choose the Bitrix24 category for the search context; defaults to 'crm'.
  • Filters — Specify one or more filter fields combined with AND logic to narrow down the search results. Supported filters include Title (contains), Pipeline (Category), Stage, Responsible User, Contact ID, Company ID, and whether the deal is closed.
  • Custom Field Filters — Add multiple custom field filters by specifying the custom field name and value for matching deals.
  • Max Results — Set the maximum number of deals to return. Set to 0 to fetch all matching records.

Output shape

A list of deal records matching the specified filters and custom field criteria.

The search combines all provided filters with AND logic. The output respects the Max Results limit unless set to 0 to retrieve all records. Authentication method impacts API endpoint and permissions.

Examples

Example 1: Find all open deals assigned to a specific user with a pipeline category selected

Set 'Responsible User' filter to the user ID, 'Is Closed' to 'No', and select the desired Pipeline Category. Optionally set Max Results to a limit.

Links

Discussion