Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

Overview

This node integrates with the Bitrix24 CRM and business platform, allowing users to interact with various Bitrix24 resources. Specifically, the "Lists" resource with the "Get Field Types" operation enables retrieving metadata about the fields available in a Bitrix24 list or entity type. This is useful for dynamically understanding the structure of data entities within Bitrix24, such as contacts, deals, leads, companies, quotes, invoices, products, activities, or custom Smart Process Automation (SPA) types.

Common scenarios include:

  • Dynamically generating forms or UI elements based on available fields.
  • Validating or mapping data before creating or updating records.
  • Automating workflows that depend on field metadata.

For example, a user might want to fetch all available fields for a CRM contact to build a custom integration or report.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24: OAuth2 (recommended), Webhook (simpler but less secure), or API Key authentication.
Options Collection of optional parameters:
  Access Token Use a specific access token instead of the one from credentials.
  Filter JSON-formatted filter criteria to narrow down results.
  Order JSON-formatted sort order specification.
  Select Comma-separated list of fields to select from the response.

Output

The node outputs an array of items where each item contains a json object representing the retrieved data from Bitrix24. For the "Get Field Types" operation under the "Lists" resource, the output typically includes:

  • Metadata about each field such as:
    • Field ID or name
    • Display label (e.g., form label, title)
    • Field type (e.g., string, integer, date)
    • Whether the field is required or read-only
    • Additional descriptive information

If an error occurs and the node is configured to continue on failure, the output will contain an error object with:

  • error: The error message
  • resource: The resource name ("lists")
  • timestamp: The time when the error occurred

The node does not output binary data.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods (OAuth2, webhook URL, or API key).
  • Needs appropriate API permissions/scopes granted in Bitrix24 to access CRM or list metadata.
  • Uses internal helper functions to make standard Bitrix24 API calls.
  • No additional external libraries beyond those bundled are required.

Troubleshooting

  • Authentication errors: Ensure the selected authentication method is correctly configured with valid credentials or tokens.
  • API permission issues: The connected Bitrix24 account must have sufficient rights to access the requested resource fields.
  • Malformed filter/order JSON: If using the filter or order options, ensure the JSON syntax is correct to avoid API call failures.
  • Empty or missing results: Could indicate no fields available for the specified entity or incorrect entity/resource selection.
  • Error messages in output: When continuing on fail, check the error message in the output JSON for details and verify API connectivity and parameters.

Links and References

Discussion