Получить список компаний по фильтру crm.company.list

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: crm

Кто может выполнять метод: пользователь с правом «Чтение» компаний

DEPRECATED

Развитие метода остановлено. Используйте crm.item.list.

Метод crm.company.list возвращает список компаний по фильтру. Является реализацией списочного метода для компаний.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

select
string[]

Список полей, которыми можно ограничить выборку.

При выборке можно использовать маски:

  • '*' — для выборки всех полей, без пользовательских и множественных,
  • 'UF_*' — для выборки всех пользовательских полей без множественных.

Маски для выборки множественных полей нет. Для выборки множественных полей укажите нужные в списке выбора — PHONE, EMAIL и так далее.

Список доступных полей для выборки можно узнать с помощью метода crm.company.fields.

По умолчанию возвращаются все поля — '*' + пользовательские поля — 'UF_*'

filter
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        

где:

  • field_n — название поля, по которому будет отфильтрована выборка элементов
  • value_n — значение фильтра

К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

Поля PHONE, EMAIL, WEB, IM — множественные. По ним фильтры работают только на точное совпадение.

Фильтр LIKE не работает с полями типа crm_status, crm_company — например, COMPANY_TYPE.

Список доступных полей для фильтрации можно узнать с помощью метода crm.company.fields.

Ключ logic в фильтре не поддерживается. Для использования сложной логики в фильтре используйте метод crm.item.list

order
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        

где:

  • field_n — название поля, по которому будет произведена сортировка выборки компаний
  • value_n — значение типа string, равное:
    • ASC — сортировка по возрастанию
    • DESC — сортировка по убыванию

Список доступных полей для сортировки можно узнать с помощью метода crm.company.fields

start
integer

Параметр для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Примеры кода

Как использовать примеры в документации

Вывести компании:

  • c сортировкой по дате создания,
  • с выборкой полей: название, ответственный, телефон,
  • по фильтру: тип компании CUSTOMER и дата создания с 2025-01-01.
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ORDER":{"DATE_CREATE":"ASC"},"FILTER":{"COMPANY_TYPE":"CUSTOMER",">=DATE_CREATE":"2025-01-01"},"SELECT":["TITLE","ASSIGNED_BY_ID","PHONE"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ORDER":{"DATE_CREATE":"ASC"},"FILTER":{"COMPANY_TYPE":"CUSTOMER",">=DATE_CREATE":"2025-01-01"},"SELECT":["TITLE","ASSIGNED_BY_ID","PHONE"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.list
        
// callListMethod: Получает все данные сразу.
        // Используйте только для небольших выборок (< 1000 элементов) из-за высокой
        // нагрузки на память.
        
        try {
        const response = await $b24.callListMethod(
            'crm.company.list',
            {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
            select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
            },
            (progress: number) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора.
        // Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
        const generator = $b24.fetchListMethod('crm.company.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
            select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start.
        // Используйте для точного контроля над пакетами запросов.
        // Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
        const response = await $b24.callMethod('crm.company.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
            select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.list',
                    [
                        'order' => ['DATE_CREATE' => 'ASC'],
                        'filter' => ['COMPANY_TYPE' => 'CUSTOMER', '>=DATE_CREATE' => '2025-01-01'],
                        'select' => ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching company list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.company.list",
            {
                order: { "DATE_CREATE": "ASC" },
                filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
                select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.list',
            [
                'order' => ['DATE_CREATE' => 'ASC'],
                'filter' => ['COMPANY_TYPE' => 'CUSTOMER', '>=DATE_CREATE' => '2025-01-01'],
                'select' => ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "TITLE": "Перекресток",
                    "ASSIGNED_BY_ID": "811",
                    "ID": "2919",
                    "PHONE": [
                        {
                            "ID": "8303",
                            "VALUE_TYPE": "WORK",
                            "VALUE": "+79998887766",
                            "TYPE_ID": "PHONE"
                        }
                    ]
                }
            ],
            "total": 1,
            "time": {
                "start": 1769498859,
                "finish": 1769498859.948139,
                "duration": 0.948138952255249,
                "processing": 0,
                "date_start": "2026-01-27T10:27:39+03:00",
                "date_finish": "2026-01-27T10:27:39+03:00",
                "operating_reset_at": 1769499459,
                "operating": 0.1621239185333252
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
array[]

Массив компаний, соответствующих фильтру. Формат возвращаемых данных зависит от параметра select

total
integer

Общее количество найденных компаний

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

-

Access denied

У пользователя нет прав на «Чтение» компаний

-

Parameter 'order' must be array

В параметр order передан не массив

-

Parameter 'filter' must be array

В параметр filter передан не массив

-

Failed to get list. General error

Произошла неизвестная ошибка

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение