метод REST scope: crm Устаревший

crm.company.list

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

Устаревший метод. Развитие метода остановлено. Используйте 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 — номер нужной страницы

Примеры запроса

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

Ответ

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 object[]

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

total integer

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

time time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Access denied."
}
Код Описание Значение
Access denied У пользователя нет прав на «Чтение» компаний
Parameter 'order' must be array В параметр order передан не массив
Parameter 'filter' must be array В параметр filter передан не массив
Failed to get list. General error Произошла неизвестная ошибка

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.