Actions31
- Company Actions
- Contact Actions
- Deal Actions
- Item Actions
- Lead Actions
- User Custom Method Actions
Overview
This node integrates with the Bitrix24 REST API to list leads from a Bitrix24 CRM system. It allows users to retrieve multiple lead records based on specified filters, selected fields, sorting order, and pagination start index. This is useful for automating workflows that require fetching lead data for further processing, reporting, or synchronization with other systems.
Practical examples include:
- Retrieving all leads created within a certain date range.
- Fetching specific lead details such as name, status, and contact information.
- Sorting leads by creation date or priority.
- Filtering leads based on custom criteria like lead source or stage.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating with Bitrix24 API. Options: OAuth2 or Webhook. |
| Input Type | How to provide input data. Options: Using Fields (fill individual parameters) or Using JSON (provide raw JSON body). |
| JSON Body | Raw JSON data representing the request body. Used only if "Input Type" is set to "Using JSON". |
| Parameters | Collection of parameters to customize the list operation when "Input Type" is "Using Fields": |
| - Select Names or IDs | Fields to include in the response. Users can choose from a list or specify field IDs via expressions. |
| - Filter Conditions | One or more filter conditions to narrow down the results. Each condition includes: • Field (name or ID) • Operation (e.g., Equals, Contains, Greater Than) • Value to compare against. |
| - Order | Sorting options for the results. Multiple order rules can be added, each specifying: • Field name or ID • Direction (ASC or DESC) |
| - Start | Number indicating the offset from which to start returning results (pagination). Defaults to 0. |
Output
The node outputs an array of lead objects in the json output field. Each object represents a lead record retrieved from Bitrix24, containing the fields requested via the "Select Names or IDs" property or all fields if none are specified.
If binary data were supported (not indicated here), it would typically represent file attachments or media related to leads, but this node focuses on JSON data only.
Dependencies
- Requires access to a Bitrix24 account with appropriate permissions to read leads.
- Requires either OAuth2 credentials or a Webhook URL configured in n8n for authentication.
- The node depends on Bitrix24 REST API availability and correct configuration of API scopes/permissions.
Troubleshooting
- Authentication errors: Ensure that the OAuth2 token or webhook URL is valid and has sufficient permissions to access lead data.
- Empty results: Check filter conditions and ensure they match existing leads. Also verify the "Start" parameter is not beyond the total number of leads.
- Invalid field names: When selecting fields or filtering, use valid field names or IDs as per Bitrix24's API documentation. Incorrect names will cause errors or empty responses.
- JSON parsing errors: If using "Using JSON" input type, ensure the JSON body is well-formed and matches the expected structure for the Bitrix24 API.
- API rate limits: Bitrix24 may impose rate limits; if exceeded, requests might fail temporarily. Implement retry logic or reduce request frequency.