Actions20
Overview
This node interacts with user-defined custom fields in Bitrix24 CRM entities such as Leads, Deals, Contacts, and Companies. Specifically for the Company resource with the Get operation, it retrieves detailed information about a specific custom user field by its ID.
Common scenarios where this node is useful include:
- Fetching metadata of a custom field to understand its configuration or display properties.
- Validating the existence and details of a custom field before performing updates or other operations.
- Integrating Bitrix24 custom field data into workflows that require dynamic field information.
For example, you might use this node to get the label, type, and settings of a custom company field identified by its unique Field ID, enabling downstream nodes to process or display this information accordingly.
Properties
| Name | Meaning |
|---|---|
| Field ID | The unique identifier of the custom user field to retrieve. This is required for the Get operation on Company resource. |
Output
The output is a JSON array containing the response from the Bitrix24 API for the requested user field. The structure typically includes:
id: The ID of the user field.fields: An object containing detailed properties of the user field such as:FIELD_NAME: Internal name of the field.EDIT_FORM_LABEL: Label shown in edit forms.LIST_COLUMN_LABEL: Label shown in lists.USER_TYPE_ID: Data type of the field (e.g., string, integer).MULTIPLE: Whether the field supports multiple values ("Y" or "N").MANDATORY: Whether the field is mandatory ("Y" or "N").SHOW_FILTER: Whether the field appears in filters.SHOW_IN_LIST: Whether the field appears in lists.- For enumeration types, a list of possible values.
If the node encounters an error, the output may contain an error message instead.
The node does not output binary data.
Dependencies
- Requires an active Bitrix24 API authentication credential configured in n8n, providing access via a webhook URL.
- Uses the Bitrix24 REST API endpoints for user field management.
- Requires network connectivity to Bitrix24 services.
Troubleshooting
No credentials got returned!
Ensure that the Bitrix24 API credential is properly set up and connected in n8n.Webhook URL is required!
The credential must include a valid webhook URL; verify the credential configuration.Bitrix24 API error: [error message]
Indicates an error response from Bitrix24 API. Check the error message for details, such as invalid Field ID or insufficient permissions.Unknown error occurred
Could be due to network issues or unexpected API responses. Verify connectivity and API limits.If the node is set to continue on fail, errors will be included in the output as error messages rather than stopping execution.