Получить список компаний по фильтру crm.company.list
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
crmКто может выполнять метод: пользователь с правом «Чтение» компаний
DEPRECATED
Развитие метода остановлено. Используйте crm.item.list.
Метод crm.company.list возвращает список компаний по фильтру. Является реализацией списочного метода для компаний.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Список полей, которыми можно ограничить выборку. При выборке можно использовать маски:
Маски для выборки множественных полей нет. Для выборки множественных полей укажите нужные в списке выбора — Список доступных полей для выборки можно узнать с помощью метода crm.company.fields. По умолчанию возвращаются все поля — |
|
filter |
Объект формата:
где:
К ключам
Поля Фильтр Список доступных полей для фильтрации можно узнать с помощью метода crm.company.fields. Ключ |
|
order |
Объект формата:
где:
Список доступных полей для сортировки можно узнать с помощью метода crm.company.fields |
|
start |
Параметр для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
Вывести компании:
- 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 |
Массив компаний, соответствующих фильтру. Формат возвращаемых данных зависит от параметра |
|
total |
Общее количество найденных компаний |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
У пользователя нет прав на «Чтение» компаний |
|
|
|
В параметр |
|
|
|
В параметр |
|
|
|
Произошла неизвестная ошибка |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новую компанию crm.company.add
- Обновить существующую компанию crm.company.update
- Получить информацию о компании crm.company.get
- Удалить компанию crm.company.delete
- Получить описание полей компании crm.company.fields
- Как найти дубликаты в CRM по телефону и email