Получить список компаний по фильтру crm.company.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each company object returned in result[]
type CrmCompanyListItem = {
ID: string
TITLE: string
ASSIGNED_BY_ID: string
PHONE?: CrmCompanyPhone[]
}
type CrmCompanyPhone = {
ID: string
VALUE_TYPE: string
VALUE: string
TYPE_ID: string
}
try {
// crm.company.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<CrmCompanyListItem[]>({
method: 'crm.company.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COMPANY_TYPE: 'CUSTOMER', '>=DATE_CREATE': '2025-01-01' },
select: ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Companies on this page:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listCompanies() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.company.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.company.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COMPANY_TYPE: 'CUSTOMER', '>=DATE_CREATE': '2025-01-01' },
select: ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Companies on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listCompanies)
</script>
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-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |