Overview

This node interacts with Bitrix24's user fields for the 'Company' resource, specifically to retrieve details of a user field by its ID. It is useful when you need to fetch metadata or configuration of custom fields defined for companies in Bitrix24, such as field labels, types, and other settings.

Use Case Examples

1. Retrieve a specific custom user field's details for a company in Bitrix24 by providing the field ID.
2. Use this node to get information about a user field before updating or deleting it.

Properties

Output

JSON

• id - The ID of the user field.
• 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 (Y/N).
• mandatory - Indicates if the field is mandatory (Y/N).
• showFilter - Indicates if the field is shown in filters (Y/N).
• showInList - Indicates if the field is shown in lists (Y/N).
• listValues - If the field is an enumeration, this contains the list of possible values.

Dependencies

• Requires Bitrix24 API credentials for authentication.

Troubleshooting

• Ensure the Field ID provided is correct and exists in the Bitrix24 Company user fields.
• If the API returns an error, check that the Bitrix24 API credentials are valid and have sufficient permissions.
• Common error messages include 'Field not found' if the ID is invalid, or authentication errors if credentials are incorrect.

Links

• Bitrix24 CRM User Fields API - Official Bitrix24 documentation for managing CRM user fields, including retrieval.