Bitrix24 User Field

Overview

This node interacts with custom user fields in Bitrix24 CRM for a specified resource such as Contact, Lead, Deal, or Company. It allows users to create, update, retrieve (get), list all, or delete custom user fields associated with these resources.

For the Contact resource and the Get operation specifically, the node fetches details of a single custom user field by its ID. This is useful when you want to retrieve metadata or configuration of a particular custom field defined in Bitrix24 Contacts, for example, to display it, validate data, or synchronize field definitions.

Practical examples:

• Retrieve a custom field's label and type before updating contact records.
• Fetch field settings to dynamically build forms or UI elements based on Bitrix24 contact custom fields.
• Audit or document existing custom fields in your Bitrix24 contacts.

Properties

Output

The output is a JSON array where each element corresponds to the API response for the requested operation.

For the Get operation on Contact user fields, the output JSON contains the detailed information about the specified custom field, including its ID, name, label, type, and other configuration properties as returned by the Bitrix24 API.

No binary data output is produced by this node.

Example output snippet (simplified):

{
  "result": {
    "ID": "UF_CRM_123456",
    "FIELD_NAME": "UF_CRM_CUSTOM_FIELD",
    "EDIT_FORM_LABEL": "Custom Field Label",
    "USER_TYPE_ID": "string",
    "MULTIPLE": "N",
    "MANDATORY": "N",
    ...
  }
}

Dependencies

• Requires an active Bitrix24 API authentication credential configured in n8n that provides a webhook URL for API calls.
• Uses HTTP POST requests to Bitrix24 webhook endpoints to perform operations.
• The node sets the default language environment variable based on credentials or defaults to Russian (ru).

Troubleshooting

• Missing Credentials or Webhook URL: The node throws errors if no credentials are found or if the webhook URL is missing. Ensure the Bitrix24 API credential is properly set up with a valid webhook URL.
• API Errors: If Bitrix24 returns an error (e.g., invalid field ID, permission issues), the node surfaces the error message prefixed with "Bitrix24 API error:". Check the field ID correctness and API permissions.
• Continue On Fail: When enabled, the node captures individual request errors and continues processing remaining items, returning error messages in the output JSON instead of failing the entire execution.
• Field ID Requirement: For the Get operation, the Field ID property is mandatory. Omitting it will cause the node to fail.

Links and References

• Bitrix24 REST API Documentation
• Bitrix24 Custom Fields Guide
• n8n Documentation - Creating Custom Nodes