Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node allows interaction with the Bitrix24 CRM and business platform. Specifically, the "Lists" resource with the "Get Fields" operation retrieves metadata about the fields of a specified list (also known as an information block or iblock) within Bitrix24. This is useful for workflows that need to dynamically understand the structure of a list before performing actions such as querying, updating, or adding elements.

Common scenarios include:

  • Fetching the schema of a custom list to build dynamic forms or filters.
  • Integrating Bitrix24 lists with other systems by mapping fields.
  • Automating data processing where field metadata guides logic.

Example: A user wants to get all available fields in a particular Bitrix24 list to display them in a dropdown for further selection or filtering.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24. Options: OAuth2 (recommended), Webhook (simpler), API Key.
List ID The unique identifier of the Bitrix24 list (information block) whose fields are to be retrieved.
Options Additional optional parameters:
- Access Token Override the default credential token with a specific access token string.
- Filter JSON object specifying filter criteria to narrow down results.
- Order JSON object defining the sort order of the returned fields.
- Select Comma-separated string listing specific fields to select from the list metadata.

Output

The output is a JSON array containing the metadata of fields for the specified list. Each item typically includes:

  • Field ID or name
  • Display label or title
  • Type information (e.g., string, integer)
  • Flags such as whether the field is required or read-only
  • Descriptions or additional metadata

This structured output enables downstream nodes or processes to understand the list's schema.

If binary data were involved (not applicable here), it would represent file contents or attachments related to list elements.

Dependencies

  • Requires valid authentication with Bitrix24 via one of the supported methods (OAuth2, webhook URL, or API key).
  • The node depends on Bitrix24 API endpoints to fetch list field metadata.
  • No additional external services beyond Bitrix24 are required.
  • Proper configuration of credentials in n8n is necessary to authorize API calls.

Troubleshooting

  • Common issues:

    • Invalid or expired authentication tokens leading to authorization errors.
    • Incorrect List ID causing "not found" or empty results.
    • Malformed JSON in filter or order options causing request failures.

  • Error messages:

    • Errors returned from Bitrix24 API will be surfaced in the node output under an error property if "Continue On Fail" is enabled.
    • Typical error: "Failed to load fields: <message>" indicates problems fetching field metadata.

  • Resolutions:

    • Verify and refresh authentication credentials.
    • Double-check the List ID is correct and accessible.
    • Ensure JSON syntax in filter/order options is valid.
    • Enable "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion