Bitrix24 icon

Bitrix24

袪邪斜芯褌邪 褋 Bitrix24 API

孝芯胁邪褉 → 袩芯谢褍褔懈褌褜

AI-generated

Overview

This node interacts with the Bitrix24 API specifically for the resource '孝芯胁邪褉' (likely 'Company' based on typical Bitrix24 resources) and performs the operation '袩芯谢褍褔懈褌褜' (Get). It allows retrieving a single record either by its ID or by applying filter criteria. Users can specify which fields to select in the response. This is useful for scenarios where you need to fetch detailed information about a specific company record in Bitrix24, either by knowing its unique ID or by searching with custom filters.

Use Case Examples

  1. Retrieve a company record by its unique ID to display detailed information in a dashboard.
  2. Fetch a company record using filter criteria such as company name or industry to integrate with another system.

Properties

Name Meaning
getBy Method to get the record, either by 'ID' or by applying a 'Filter'.
id The unique identifier of the record to retrieve. Required if 'getBy' is set to 'ID'.
filterFields A collection of filter criteria fields to apply when retrieving the record by filter. Each filter includes the field name, operation (e.g., equals, greater than), and value to match.
selectFields List of fields to include in the response, allowing to select only relevant data.

Output

JSON

  • ID - The unique identifier of the retrieved record.
  • fields - The data fields of the retrieved record with their values.
  • error - Error message if the record was not found or another issue occurred.

Dependencies

  • Bitrix24 API with an API key credential

Troubleshooting

  • If the node returns an error stating 'Запись не найдена' (Record not found), verify that the provided ID or filter criteria are correct and that the record exists in Bitrix24.
  • Ensure the API credentials are valid and have sufficient permissions to access the '孝芯胁邪褉' resource.
  • If using filters, confirm that the filter fields and operations are supported and correctly formatted.

Discussion