Как использовать метод SDK crm.company.userfield.list в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK crm.company.userfield.list в Битрикс24», проанализируем лучшие практики и покажем, как правильно использовать crm.company.userfield.list в реальных задачах.

Описание метода SDK crm.company.userfield.list

Метод crm.company.userfield.list является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. The method crm.company.userfield.list returns a list of custom company fields based on the filter.

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\CRM\Company\Service\CompanyUserfield со следующей сигнатурой:

public function list(
      array $order = [],
      array $filter = []
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод list:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода crm.company.userfield.list
    $order = [];
    $filter = [];

    // Выполнение запроса через Scope getCRMScope и сервис company
    $result = $serviceBuilder->getCRMScope()->company()->list(
          $order,
          $filter
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода crm.company.userfield.list: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://apidocs.bitrix24.com/api-reference/crm/companies/userfields/crm-company-userfield-list.html
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk