Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Overview

This node integrates with the Bitrix24 CRM and business platform, allowing users to interact programmatically with various CRM entities. Specifically, the CRM - Get Fields operation retrieves metadata about fields available for a selected CRM entity type (such as contacts, deals, leads, companies, quotes, invoices, products, or activities). This is useful when you want to dynamically understand what data fields exist for an entity before performing further operations like creating, updating, or querying records.

Common scenarios:

  • Dynamically populating UI dropdowns with available fields for a chosen CRM entity.
  • Validating input data against the actual fields supported by Bitrix24 CRM.
  • Building integrations that adapt to custom fields or changes in the CRM schema without hardcoding field names.

Practical example:
You select the "Contact" entity and run this operation to get all contact fields except some system fields (like ID or creation date). You then use these fields to map incoming data from another system into Bitrix24 contacts.


Properties

Name Meaning
Authentication Method of authenticating with Bitrix24:
- OAuth2 (recommended for production)
- Webhook (simpler but less secure)
- API Key authentication
Entity The CRM entity type to retrieve fields for:
- Contact
- Deal
- Lead
- Company
- Quote
- Invoice
- Product
- Activity

Output

The output JSON contains an array of field definitions for the selected CRM entity. Each field object includes:

  • name: The display name of the field (derived from labels or titles).
  • value: The internal field ID used in Bitrix24 API calls.
  • description: A string describing the field type and whether it is required.

System/internal fields such as IDs and timestamps are excluded from the list.

No binary data output is produced by this operation.


Dependencies

  • Requires valid authentication credentials for Bitrix24 via one of the supported methods (OAuth2, webhook URL, or API key).
  • Uses Bitrix24 REST API endpoints specific to CRM entities to fetch field metadata.
  • The node relies on internal helper functions to make standardized API calls to Bitrix24.

Troubleshooting

  • Error loading fields: If the node returns an error message indicating failure to load CRM fields, verify that:

    • The authentication credentials are correct and have sufficient permissions.
    • The selected entity type is valid and accessible in your Bitrix24 account.
    • The Bitrix24 API service is operational and reachable from n8n.
  • Empty or incomplete field list: Some fields may be filtered out intentionally (e.g., system fields). If expected fields are missing, check if they are custom fields requiring additional permissions or if the API response has changed.

  • Authentication issues: Ensure the chosen authentication method matches your Bitrix24 setup. OAuth2 is recommended for production environments due to better security.


Links and References

Discussion