Bitrix icon

Bitrix

Consume Bitrix24 REST API

Overview

This node integrates with the Bitrix24 CRM system to list items of a specified entity type. It allows users to retrieve records from Bitrix24 by specifying filters, sorting order, and selected fields. This is useful for workflows that need to fetch CRM data such as products, deals, contacts, or custom entities for further processing, reporting, or automation.

Practical examples include:

  • Retrieving a filtered list of CRM items (e.g., all deals with a certain status).
  • Fetching specific fields of CRM items to update another system.
  • Sorting CRM items by creation date or name for display or analysis.

Properties

Name Meaning
Authentication Method used to authenticate with Bitrix24 API. Options: OAuth2 or Webhook.
Entity Type Name or ID Identifier of the Bitrix24 entity type to list items from. Choose from a dynamically loaded list or specify an ID directly. Examples include standard or user-defined entity types.
Input Type How to provide input parameters: "Using Fields" to fill individual parameters or "Using JSON" to provide raw JSON data.
JSON Body Raw JSON data representing the request body, used when "Input Type" is set to JSON.
Parameters Collection of parameters to customize the list operation when using "Using Fields":
- Select Names or IDs Fields to include in the response. Can be chosen from a list or specified via expression.
- Filter Conditions One or more filter conditions to restrict which items are returned. Each condition includes a field, an operation (e.g., equals, contains), and a value to compare against.
- Order Sorting instructions, each specifying a field and direction (ASC or DESC).
- Start Number indicating the offset from which to start returning results (for pagination).
Use Original UF Names Boolean flag indicating whether to use original custom field names prefixed with UF_CRM instead of their mapped names.

Output

The node outputs a JSON array of objects representing the listed CRM items matching the specified criteria. Each object contains the fields requested in the "Select Names or IDs" property or all fields if none specified. The output does not include binary data.

Dependencies

  • Requires authentication credentials for Bitrix24, either via OAuth2 or Webhook.
  • Needs proper configuration of these credentials within n8n.
  • Relies on Bitrix24 REST API availability and permissions granted to the authenticated user.

Troubleshooting

  • Authentication errors: Ensure the provided API key or OAuth2 token is valid and has sufficient permissions to access the requested entity type.
  • Invalid entity type: If the entity type ID is incorrect or not accessible, the node will fail. Verify the entity type exists in Bitrix24.
  • Filter syntax issues: Incorrect filter operations or values may cause API errors. Double-check filter conditions and supported operations.
  • Empty results: Could be due to no matching records or incorrect filter criteria. Try broadening filters or removing them to test.
  • Pagination problems: Using the "Start" parameter incorrectly might skip desired records. Adjust accordingly.

Links and References

Discussion