Actions29
Deal → List
AI-generatedSummary
List deals from Bitrix24 CRM applying optional filters such as stage, pipeline, responsible user, contact or company ID, closure status, currency, and creation or closure dates. Retrieve up to a specified limit of deals or all available if limit is zero.
Inputs
- Authentication (required) — Choose between Webhook or OAuth2 authentication methods to access the Bitrix24 API.
- Category (required) — Select the CRM category context, defaulting to 'crm' for deals.
- Quick Filters — Apply filters to narrow down the deals list, including stage, pipeline category, responsible user, contact ID, company ID, whether the deal is closed, currency (ISO code), and date ranges for creation or closure.
- Max Results — Set the maximum number of deal records to return. Set to 0 to fetch all records.
Output shape
a list of deal objects with their details as returned by the Bitrix24 CRM, reflecting filtered criteria and pagination by the 'Max Results' parameter.
If 'Max Results' is set to 0, the operation paginates internally to return all deals matching filters. Filters on custom fields may be applied if specified in 'Quick Filters'. The authentication method impacts API access but does not alter output shape.
Examples
Example 1: Retrieve up to 50 open deals assigned to a specific user in a particular pipeline stage
Authentication via Webhook, Category set to CRM, Quick Filters with Stage and Responsible User, Max Results 50
Example 2: Fetch all deals created after a specific date including both open and closed deals
Authentication via OAuth2, Category CRM, Quick Filters with Created After date filter, Max Results set to 0 for all records