Overview

This node interacts with Bitrix24 CRM to manage user fields for various resources, including Contacts. Specifically, for the 'Contact' resource and 'Get' operation, it retrieves details of a specific user field by its Field ID. This is useful for scenarios where you need to fetch metadata or configuration of custom fields in Bitrix24 Contacts, such as for integration, reporting, or automation purposes.

Use Case Examples

1. Retrieve the configuration of a custom user field in Bitrix24 Contacts by specifying its Field ID to use the field's metadata in further workflow steps.
2. Fetch details of a specific contact field to verify its properties or to dynamically adjust workflow logic based on field attributes.

Properties

Output

JSON

• id - The unique identifier of the user field.
• fieldName - The internal name of the user field.
• fieldLabel - The display label 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 credentials

Troubleshooting

• Ensure the Field ID provided is correct and exists in the Bitrix24 Contact user fields; otherwise, the API will return an error.
• Verify that the Bitrix24 API credentials are valid and have sufficient permissions to access user fields.
• Common error messages include 'Field not found' if the Field ID is invalid, or authentication errors if credentials are incorrect. Resolving these involves checking the Field ID and re-authenticating the API credentials.

Links

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