Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Actions25

Overview

This node integrates with the Bitrix24 CRM API to perform various operations on CRM records. Specifically, for the Default resource and the Get operation, it retrieves a single record either by its unique ID or by applying filter criteria.

Common scenarios where this node is useful include:

  • Fetching detailed information about a specific CRM entity (like a lead, deal, contact, or company) when you know its ID.
  • Searching for a record based on one or more field filters, such as retrieving a contact by email or a deal by status.
  • Selecting only certain fields from the record to reduce data volume or focus on relevant attributes.

Practical example:

  • You want to get details of a lead with ID "12345" to enrich your workflow with up-to-date information.
  • You want to find a contact whose email contains "example.com" and retrieve their phone number and name.

Properties

Name Meaning
Get By Method to retrieve the record:
- ID: Get the record by its unique identifier.
- Filter: Get the record by applying filter conditions on fields.
ID The unique identifier of the record to retrieve. Required if "Get By" is set to "ID".
Filter Fields A collection of filter conditions to apply when "Get By" is set to "Filter". Each filter includes:
- Field Name: The field to filter by.
- Operation: Comparison operator (e.g., equals, contains, greater than).
- Value: The value to compare against.
Select Fields List of fields to retrieve from the record. If empty, default fields for the resource are returned.

Filter Operations Available

  • Equals
  • Not Equals
  • Greater Than
  • Greater Than or Equal
  • Less Than
  • Less Than or Equal
  • Contains
  • Not Contains
  • Starts With
  • Ends With
  • In List
  • Not In List

Output

The output is a JSON array containing the retrieved record(s):

  • For Get by ID, the output contains a single record object with the requested fields.
  • For Get by Filter, the output contains the first matching record or an error message if no record is found.
  • The structure of each record matches the Bitrix24 CRM entity schema, including standard and custom fields.
  • No binary data is output by this node.

Example output snippet (simplified):

[
  {
    "ID": "12345",
    "NAME": "John Doe",
    "EMAIL": "john.doe@example.com",
    "PHONE": "+1234567890"
  }
]

If no record is found by filter:

[
  {
    "error": "Запись не найдена"
  }
]

Dependencies

  • Requires a valid Bitrix24 API webhook URL credential configured in n8n.
  • Uses the Bitrix24 REST API endpoints via HTTP POST requests.
  • Axios library is used internally for HTTP requests.
  • The node expects the webhook URL to be provided in credentials; no other authentication method is supported here.

Troubleshooting

  • Missing Credentials or Webhook URL: The node will throw errors if the Bitrix24 API credentials or webhook URL are not set or invalid. Ensure credentials are properly configured.
  • Invalid Record ID: If the specified ID does not exist, the node returns an error indicating the record was not found.
  • Filter Syntax Errors: Filters must be correctly constructed with valid field names and operations. Invalid filters may result in no results or API errors.
  • API Response Issues: Network problems or incorrect webhook URLs can cause request failures. Check connectivity and webhook correctness.
  • Empty Select Fields: If no select fields are specified, the node uses a default set of fields per resource. To optimize performance, specify only needed fields.

Links and References

Discussion