Overview

This node interacts with Bitrix24 CRM to manage user fields for the Lead resource. Specifically, for the 'Get' operation, it retrieves details of a specific user field by its Field ID. This is useful when you need to fetch metadata or configuration of custom fields associated with leads in Bitrix24, such as for integration, reporting, or automation purposes.

Use Case Examples

1. Retrieve the configuration of a custom lead field by specifying its Field ID to understand its properties or to use its data in further workflow steps.
2. Fetch details of a lead user field to verify its settings before updating or deleting it.

Properties

Output

JSON

• id - The ID of the user field retrieved.
• fieldName - The internal name of the user field.
• fieldLabel - The label or display name of the user field.
• userTypeId - The data type of the user field (e.g., string, integer, enumeration).
• multiple - Indicates if the field supports multiple values.
• mandatory - Indicates if the field is mandatory.
• showFilter - Indicates if the field is shown in filters.
• showInList - Indicates if the field is shown in lists.
• listValues - If the field is an enumeration, this contains the list of possible values.

Dependencies

• Bitrix24 API authentication credential

Troubleshooting

• Ensure the Field ID is correct and exists in the Bitrix24 Lead user fields; otherwise, the API will return an error.
• Check that the Bitrix24 API credentials are valid and have sufficient permissions to access user fields.
• If the node throws a Bitrix24 API error, verify network connectivity and API endpoint availability.

Links

• Bitrix24 CRM User Field Get API - Official Bitrix24 documentation for retrieving user field details via API.