Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Actions25

Overview

This node integrates with the Bitrix24 CRM system, specifically enabling users to list records of a chosen resource type (such as leads, deals, contacts, or companies). The "List" operation fetches multiple records from Bitrix24, optionally applying filters and selecting specific fields. This is useful for workflows that need to retrieve batches of CRM data for processing, reporting, or synchronization with other systems.

Practical examples:

  • Retrieve all active leads with a certain status.
  • Fetch a limited number of deals filtered by amount or date.
  • List contacts whose email contains a specific domain.
  • Extract company records selecting only name and industry fields.

Properties

Name Meaning
Return All Boolean option to return all matching records without limit.
Limit Maximum number of records to return when "Return All" is false.
Use Filter Boolean option to enable filtering of records based on specified criteria.
Filter Fields Collection of filter conditions; each includes:
- Field Name: The field to filter by (loaded dynamically from Bitrix24 fields).
- 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 fields to retrieve for each record (loaded dynamically from Bitrix24 fields).

Output

The output is a JSON array where each element represents a Bitrix24 record matching the query. Each record object contains key-value pairs corresponding to the selected fields or default fields if none are specified.

If binary data were involved, it would be summarized here, but this node outputs only JSON data representing CRM records.

Example output snippet:

[
  {
    "ID": "123",
    "TITLE": "Lead Title",
    "STATUS_ID": "NEW",
    "PHONE": "+1234567890"
  },
  {
    "ID": "124",
    "TITLE": "Another Lead",
    "STATUS_ID": "CONTACTED",
    "PHONE": "+0987654321"
  }
]

Dependencies

  • Requires an API authentication token configured in n8n credentials to access Bitrix24.
  • Uses the Bitrix24 webhook URL from credentials to construct API endpoints.
  • Relies on Bitrix24 REST API endpoints for CRM entities.
  • Uses axios HTTP client internally for API requests.

Troubleshooting

  • Missing Credentials or Webhook URL: The node throws errors if no credentials or webhook URL are provided. Ensure the API key and webhook URL are correctly set up in n8n credentials.
  • Invalid Filter Configuration: Filters must use valid field names and operations. Invalid or misspelled fields may cause empty results or errors.
  • API Rate Limits or Connectivity Issues: Network problems or Bitrix24 API limits can cause request failures. Check connectivity and API usage quotas.
  • JSON Parsing Errors: When using JSON input format for fields, ensure the JSON is well-formed.
  • Empty Results: If no records match the filter, the output will be an empty array or contain an error message indicating no records found.

Links and References

Discussion