Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Overview

This node integrates with the Bitrix24 CRM system to perform operations on company records. Specifically, for the Company - Get operation, it retrieves a single company record either by its unique ID or by applying filter criteria on company fields.

Common scenarios where this node is useful include:

  • Fetching detailed information about a specific company when you know its ID.
  • Searching for a company based on certain attributes (e.g., name, industry) using filters.
  • Automating workflows that require company data retrieval from Bitrix24 for further processing or decision-making.

Practical example:

  • You have a list of company IDs and want to fetch their details one by one.
  • You want to find a company whose name contains "Tech" and retrieve its information.

Properties

Name Meaning
Get By Choose how to get the company: by ID or by Filter (custom field conditions).
ID The unique identifier of the company record to retrieve (required if "Get By" is set to ID).
Filter Fields One or more filter conditions to apply when searching for a company. Each filter includes:
- Field Name: The company field to filter by (loaded dynamically from Bitrix24).
- Operation: The comparison operator, options include Equals, Not Equals, Greater Than, Contains, etc.
- Value: The value to compare the field against.
Select Fields List of specific company fields to retrieve in the response. If empty, default fields are returned.

Output

The output JSON array contains the retrieved company record(s) as objects with key-value pairs representing company fields and their values.

  • When getting by ID or filter, the output is a single company object if found.
  • If no matching record is found, the output contains an error message indicating the record was not found.
  • The structure corresponds to Bitrix24's company entity fields.
  • No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "ID": "123",
    "TITLE": "Example Company",
    "ADDRESS": "123 Main St",
    "PHONE": "+1234567890"
  }
]

Dependencies

  • Requires a valid Bitrix24 API webhook URL credential configured in n8n.
  • Uses Bitrix24 REST API endpoints to query company data.
  • Network access to Bitrix24 API must be available.
  • The node dynamically loads available company fields from Bitrix24 to populate options.

Troubleshooting

  • Missing credentials or webhook URL: The node will throw errors if the Bitrix24 API credential or webhook URL is not set or invalid. Ensure these are properly configured.
  • Invalid ID or no matching record: If the specified company ID does not exist, the node returns an error message in the output JSON indicating the record was not found.
  • Filter syntax issues: Filters must use supported operations and valid field names. Incorrect filter configuration may result in no results or errors.
  • API rate limits or connectivity issues: Network problems or Bitrix24 API limits can cause request failures. Check network connectivity and API usage quotas.
  • Field loading errors: If the node cannot load company fields dynamically, it may fail to provide filter or select options. Verify API access and webhook URL correctness.

Links and References

Discussion