Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Actions25

Overview

This node integrates with the Bitrix24 CRM system to manage Lead records. Specifically, the "List" operation for the Lead resource retrieves multiple lead records from Bitrix24. It supports returning all leads or a limited number, optionally filtered by various field conditions, and allows selecting specific fields to retrieve.

Common scenarios include:

  • Fetching all leads or a subset based on criteria for reporting or further processing.
  • Filtering leads by status, source, or custom fields to target specific segments.
  • Selecting only relevant fields to optimize data handling and reduce payload size.

Example use cases:

  • Retrieve all new leads created in the last week for follow-up.
  • List leads where the company name contains a certain keyword.
  • Get a limited list of leads with only their names and contact information.

Properties

Name Meaning
Return All Boolean flag to return all lead records without limit.
Limit Maximum number of lead records to return (used if Return All is false).
Use Filter Boolean flag to enable filtering of lead records.
Filter Fields Collection of filter conditions; each includes:
- Field Name: The lead field to filter by (loaded dynamically from Bitrix24).
- Operation: Comparison operator such as Equals, Not Equals, Greater Than, Contains, Starts With, etc.
- Value: The value to compare the field against.
Select Fields Multi-select list of lead fields to retrieve. If empty, default fields are returned.

Output

The output is a JSON array of lead records matching the query parameters. Each record contains the selected fields with their values as returned by the Bitrix24 API.

  • If "Return All" is true, all matching leads are returned.
  • If "Return All" is false, up to "Limit" records are returned.
  • If filters are applied, only leads matching those filters are included.
  • The structure of each lead object corresponds to the selected fields or defaults if none specified.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Bitrix24 API connection configured with a valid webhook URL and authentication credentials.
  • Uses HTTP POST requests to Bitrix24 REST API endpoints for leads.
  • The node expects the webhook URL to be set in the credentials and uses it to construct API URLs.
  • No additional environment variables beyond the credential configuration are required.

Troubleshooting

  • Missing Credentials or Webhook URL: The node will throw errors if no credentials or webhook URL are provided. Ensure the Bitrix24 API credentials are correctly configured.
  • Invalid Filter Fields: Filters must use valid field names and supported operations. Invalid or misspelled field names may cause empty results or errors.
  • API Errors: Network issues or Bitrix24 API errors will result in error messages. Check connectivity and API permissions.
  • Empty Results: If no leads match the filters or selection criteria, the output will be an empty array or contain an error message indicating no records found.
  • JSON Parsing Errors: When using JSON input formats elsewhere, malformed JSON can cause failures, but this does not apply directly to the List operation.

Links and References

Discussion