Получить список сделок crm.deal.list

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

Scope: crm

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

DEPRECATED

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

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

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

Название
тип

Описание

select
string[]

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

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

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

Список доступных полей для выборки можно узнать с помощью метода crm.deal.fields.
Метод не поддерживает поле CONTACT_IDS, для получения сделок со списком контактов используйте метод crm.item.list.

По умолчанию берутся все поля — '*' + Пользовательские поля — '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 (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

Фильтр LIKE не работает с полями типа crm_status, crm_contact, crm_company (тип сделки TYPE_ID, стадия STAGE_ID и так далее).

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

Фильтр не поддерживает поле CONTACT_IDS, для фильтрации по контактам используйте метод 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.deal.fields

start
integer

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

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

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

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

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

Так же смотрите описание списочных методов.

Примеры кода

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

Получить список сделок, у которых:

  1. идентификатор воронки равен 1
  2. тип сделки равен COMPLEX (комплексная продажа)
  3. название заканчивается на а
  4. стадия равна С1:NEW (новая)
  5. сумма больше 10000, но меньше или равна 20000
  6. включен ручной режим подсчета суммы
  7. ответственным является либо пользователь с id = 1, либо пользователь с id = 6
  8. сделка создана не менее 6 месяцев назад

Задать следующий порядок сортировки у данной выборки: название и сумма в порядке возрастания.

Для наглядности выбрать только необходимые поля:

  • Идентификатор ID
  • Название TITLE
  • Тип сделки TYPE_ID
  • Идентификатор воронки CATEGORY_ID
  • Стадия STAGE_ID
  • Сумма OPPORTUNITY
  • Включен ли ручной режим IS_MANUAL_OPPORTUNITY
  • Ответственный ASSIGNED_BY_ID
  • Дата создания DATE_CREATE
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","TITLE","TYPE_ID","CATEGORY_ID","STAGE_ID","OPPORTUNITY","IS_MANUAL_OPPORTUNITY","ASSIGNED_BY_ID","DATE_CREATE"],"FILTER":{"=%TITLE":"%а","CATEGORY_ID":1,"TYPE_ID":"COMPLEX","STAGE_ID":"C1:NEW",">OPPORTUNITY":10000,"<=OPPORTUNITY":20000,"IS_MANUAL_OPPORTUNITY":"Y","@ASSIGNED_BY_ID":[1,6],">DATE_CREATE":"'"$(date --date='-6 months' +%Y-%m-%d)"'"},"ORDER":{"TITLE":"ASC","OPPORTUNITY":"ASC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","TITLE","TYPE_ID","CATEGORY_ID","STAGE_ID","OPPORTUNITY","IS_MANUAL_OPPORTUNITY","ASSIGNED_BY_ID","DATE_CREATE"],"FILTER":{"=%TITLE":"%а","CATEGORY_ID":1,"TYPE_ID":"COMPLEX","STAGE_ID":"C1:NEW",">OPPORTUNITY":10000,"<=OPPORTUNITY":20000,"IS_MANUAL_OPPORTUNITY":"Y","@ASSIGNED_BY_ID":[1,6],">DATE_CREATE":"'"$(date --date='-6 months' +%Y-%m-%d)"'"},"ORDER":{"TITLE":"ASC","OPPORTUNITY":"ASC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        const now = new Date();
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(now.getMonth() - 6);
        
        try {
          const response = await $b24.callListMethod(
            'crm.deal.list',
            {
              select: [
                'ID',
                'TITLE',
                'TYPE_ID',
                'CATEGORY_ID',
                'STAGE_ID',
                'OPPORTUNITY',
                'IS_MANUAL_OPPORTUNITY',
                'ASSIGNED_BY_ID',
                'DATE_CREATE',
              ],
              filter: {
                '=%TITLE': '%а',
                CATEGORY_ID: 1,
                TYPE_ID: 'COMPLEX',
                STAGE_ID: 'C1:NEW',
                '>OPPORTUNITY': 10000,
                '<=OPPORTUNITY': 20000,
                IS_MANUAL_OPPORTUNITY: 'Y',
                '@ASSIGNED_BY_ID': [1, 6],
                '>DATE_CREATE': sixMonthAgo,
              },
              order: {
                TITLE: 'ASC',
                OPPORTUNITY: 'ASC',
              },
            },
            (result) => {
              result.error()
                ? console.error(result.error())
                : console.info(result.data())
              ;
            },
          );
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        const now = new Date();
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(now.getMonth() - 6);
        
        try {
          const generator = $b24.fetchListMethod('crm.deal.list', {
            select: [
              'ID',
              'TITLE',
              'TYPE_ID',
              'CATEGORY_ID',
              'STAGE_ID',
              'OPPORTUNITY',
              'IS_MANUAL_OPPORTUNITY',
              'ASSIGNED_BY_ID',
              'DATE_CREATE',
            ],
            filter: {
              '=%TITLE': '%а',
              CATEGORY_ID: 1,
              TYPE_ID: 'COMPLEX',
              STAGE_ID: 'C1:NEW',
              '>OPPORTUNITY': 10000,
              '<=OPPORTUNITY': 20000,
              IS_MANUAL_OPPORTUNITY: 'Y',
              '@ASSIGNED_BY_ID': [1, 6],
              '>DATE_CREATE': sixMonthAgo,
            },
            order: {
              TITLE: 'ASC',
              OPPORTUNITY: 'ASC',
            },
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) {
              console.log('Entity:', entity);
            }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        const now = new Date();
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(now.getMonth() - 6);
        
        try {
          const response = await $b24.callMethod('crm.deal.list', {
            select: [
              'ID',
              'TITLE',
              'TYPE_ID',
              'CATEGORY_ID',
              'STAGE_ID',
              'OPPORTUNITY',
              'IS_MANUAL_OPPORTUNITY',
              'ASSIGNED_BY_ID',
              'DATE_CREATE',
            ],
            filter: {
              '=%TITLE': '%а',
              CATEGORY_ID: 1,
              TYPE_ID: 'COMPLEX',
              STAGE_ID: 'C1:NEW',
              '>OPPORTUNITY': 10000,
              '<=OPPORTUNITY': 20000,
              IS_MANUAL_OPPORTUNITY: 'Y',
              '@ASSIGNED_BY_ID': [1, 6],
              '>DATE_CREATE': sixMonthAgo,
            },
            order: {
              TITLE: 'ASC',
              OPPORTUNITY: 'ASC',
            },
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) {
            console.log('Entity:', entity);
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.list',
                    [
                        'select' => [
                            'ID',
                            'TITLE',
                            'TYPE_ID',
                            'CATEGORY_ID',
                            'STAGE_ID',
                            'OPPORTUNITY',
                            'IS_MANUAL_OPPORTUNITY',
                            'ASSIGNED_BY_ID',
                            'DATE_CREATE',
                        ],
                        'filter' => [
                            '=%TITLE'              => '%а',
                            'CATEGORY_ID'          => 1,
                            'TYPE_ID'              => 'COMPLEX',
                            'STAGE_ID'             => 'C1:NEW',
                            '>OPPORTUNITY'         => 10000,
                            '<=OPPORTUNITY'        => 20000,
                            'IS_MANUAL_OPPORTUNITY' => 'Y',
                            '@ASSIGNED_BY_ID'      => [1, 6],
                            '>DATE_CREATE'         => $sixMonthAgo,
                        ],
                        'order' => [
                            'TITLE'       => 'ASC',
                            'OPPORTUNITY' => 'ASC',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching deal list: ' . $e->getMessage();
        }
        
const now = new Date();
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(now.getMonth() - 6);
        
        BX24.callMethod(
            'crm.deal.list',
            {
                select: [
                    'ID',
                    'TITLE',
                    'TYPE_ID',
                    'CATEGORY_ID',
                    'STAGE_ID',
                    'OPPORTUNITY',
                    'IS_MANUAL_OPPORTUNITY',
                    'ASSIGNED_BY_ID',
                    'DATE_CREATE',
                ],
                filter: {
                    '=%TITLE': '%а',
                    CATEGORY_ID: 1,
                    TYPE_ID: 'COMPLEX',
                    STAGE_ID: 'C1:NEW',
                    '>OPPORTUNITY': 10000,
                    '<=OPPORTUNITY': 20000,
                    IS_MANUAL_OPPORTUNITY: 'Y',
                    '@ASSIGNED_BY_ID': [1, 6],
                    '>DATE_CREATE': sixMonthAgo,
                },
                order: {
                    TITLE: 'ASC',
                    OPPORTUNITY: 'ASC',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $sixMonthAgo = (new DateTime())->modify('-6 months')->format('Y-m-d');
        
        $result = CRest::call(
            'crm.deal.list',
            [
                'SELECT' => [
                    'ID',
                    'TITLE',
                    'TYPE_ID',
                    'CATEGORY_ID',
                    'STAGE_ID',
                    'OPPORTUNITY',
                    'IS_MANUAL_OPPORTUNITY',
                    'ASSIGNED_BY_ID',
                    'DATE_CREATE',
                ],
                'FILTER' => [
                    '=%TITLE' => '%а',
                    'CATEGORY_ID' => 1,
                    'TYPE_ID' => 'COMPLEX',
                    'STAGE_ID' => 'C1:NEW',
                    '>OPPORTUNITY' => 10000,
                    '<=OPPORTUNITY' => 20000,
                    'IS_MANUAL_OPPORTUNITY' => 'Y',
                    '@ASSIGNED_BY_ID' => [1, 6],
                    '>DATE_CREATE' => $sixMonthAgo,
                ],
                'ORDER' => [
                    'TITLE' => 'ASC',
                    'OPPORTUNITY' => 'ASC',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "37",
                    "TITLE": "[А] Сделка",
                    "TYPE_ID": "COMPLEX",
                    "CATEGORY_ID": "1",
                    "STAGE_ID": "C1:NEW",
                    "OPPORTUNITY": "19999.99",
                    "IS_MANUAL_OPPORTUNITY": "Y",
                    "ASSIGNED_BY_ID": "1",
                    "DATE_CREATE": "2024-09-02T18:37:18+02:00"
                },
                {
                    "ID": "38",
                    "TITLE": "[А] Сделка",
                    "TYPE_ID": "COMPLEX",
                    "CATEGORY_ID": "1",
                    "STAGE_ID": "C1:NEW",
                    "OPPORTUNITY": "20000.00",
                    "IS_MANUAL_OPPORTUNITY": "Y",
                    "ASSIGNED_BY_ID": "6",
                    "DATE_CREATE": "2024-09-02T18:37:38+02:00"
                },
                {
                    "ID": "39",
                    "TITLE": "[Б] Продажа",
                    "TYPE_ID": "COMPLEX",
                    "CATEGORY_ID": "1",
                    "STAGE_ID": "C1:NEW",
                    "OPPORTUNITY": "12500.00",
                    "IS_MANUAL_OPPORTUNITY": "Y",
                    "ASSIGNED_BY_ID": "1",
                    "DATE_CREATE": "2024-04-09T23:11:01+02:00"
                },
                {
                    "ID": "40",
                    "TITLE": "[Б] Сделка",
                    "TYPE_ID": "COMPLEX",
                    "CATEGORY_ID": "1",
                    "STAGE_ID": "C1:NEW",
                    "OPPORTUNITY": "13500.00",
                    "IS_MANUAL_OPPORTUNITY": "Y",
                    "ASSIGNED_BY_ID": "6",
                    "DATE_CREATE": "2024-08-08T19:00:14+02:00"
                },
                {
                    "ID": "41",
                    "TITLE": "[В] Сделка",
                    "TYPE_ID": "COMPLEX",
                    "CATEGORY_ID": "1",
                    "STAGE_ID": "C1:NEW",
                    "OPPORTUNITY": "11500.00",
                    "IS_MANUAL_OPPORTUNITY": "Y",
                    "ASSIGNED_BY_ID": "6",
                    "DATE_CREATE": "2024-05-08T09:38:23+02:00"
                },
                {
                    "ID": "42",
                    "TITLE": "[С] Сделка",
                    "TYPE_ID": "COMPLEX",
                    "CATEGORY_ID": "1",
                    "STAGE_ID": "C1:NEW",
                    "OPPORTUNITY": "18500.00",
                    "IS_MANUAL_OPPORTUNITY": "Y",
                    "ASSIGNED_BY_ID": "6",
                    "DATE_CREATE": "2024-07-02T15:38:32+02:00"
                }
            ],
            "total": 6,
            "time": {
                "start": 1725292115.026221,
                "finish": 1725292115.907058,
                "duration": 0.8808369636535645,
                "processing": 0.2484450340270996,
                "date_start": "2024-09-02T17:48:35+02:00",
                "date_finish": "2024-09-02T17:48:35+02:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
deal[]

Корневой элемент ответа. Содержит массив из объектов, содержащих информацию о полях сделок.

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

total
integer

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

next
integer

Содержит значение, которое нужно передать в следующий запрос в параметр start, чтобы получить следующую порцию данных.

Параметр next появляется в ответе, если количество элементов, соответствующих вашему запросу, превышает значение 50

time
time

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Parameter 'filter' must be array."
        }
        

Название
тип

Описание

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

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

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

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

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