Actions31
- Company Actions
- Contact Actions
- Deal Actions
- Item Actions
- Lead Actions
- User Custom Method Actions
Overview
This node interacts with the Bitrix24 CRM system to retrieve metadata about custom fields for a specified CRM entity type (referred to as "Item" in this context). Specifically, the "Get Fields Description" operation fetches descriptions of fields available for a given entity type within Bitrix24. This is useful when you want to dynamically understand or display the structure of CRM entities, such as contacts, deals, or custom items, before performing further operations like data retrieval or updates.
Practical examples include:
- Dynamically generating forms based on the fields available for a CRM entity.
- Validating input data against the actual field definitions in Bitrix24.
- Building integrations that adapt to changes in CRM schema without hardcoding field names.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate with Bitrix24: either OAuth2 or Webhook authentication. |
| Entity Type Name or ID | Identifier of the CRM entity type whose fields description is requested. Choose from a list or specify an ID. |
| Use Original UF Names | Boolean flag indicating whether to use original custom field prefixes (UF_CRM) for custom field names. |
Output
The node outputs JSON data containing the descriptions of fields for the specified CRM entity type. This typically includes field names, types, labels, and possibly other metadata describing each field's characteristics.
If binary data were involved (not indicated here), it would represent file attachments or similar content, but this node focuses on JSON metadata output only.
Dependencies
- Requires connection to a Bitrix24 instance via either OAuth2 or Webhook authentication.
- The user must configure appropriate credentials in n8n for Bitrix24 API access.
- The node depends on Bitrix24 REST API availability and permissions granted by the authenticated user.
Troubleshooting
Common issues:
- Invalid or expired authentication tokens can cause authorization errors.
- Specifying an incorrect or unsupported entity type ID will result in errors or empty responses.
- Network connectivity problems may prevent API calls from succeeding.
Error messages and resolutions:
- Unauthorized / 401 errors: Check that the API credentials are valid and have not expired.
- Entity type not found: Verify the entity type ID or name is correct and exists in your Bitrix24 instance.
- API rate limits exceeded: Wait and retry later or adjust usage patterns.
Links and References
- Bitrix24 REST API Documentation
- n8n Expressions Documentation (for using expressions in property values)