Получить список лидов crm.lead.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правами на чтение лидов

DEPRECATED

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

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

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

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

Название
тип

Описание

select
array

Массив содержит список полей, которые необходимо выбрать (смотрите поля лида crm-lead-fields).

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

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

Маски для выборки множественных полей нет. Для выборки множественных полей укажите нужные в списке выбора ("PHONE", "EMAIL" и так далее).
Возможности добавить к фильтру логическое условие OR, если нужно выбрать по нескольким разным полям, нет

filter
object

Объект для фильтрации выбранных лидов в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям лида crm-lead-fields.

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

  • >= — больше либо равно

  • > — больше

  • <= — меньше либо равно

  • < — меньше

  • @ — IN (в качестве значения передаётся массив)

  • !@— NOT IN (в качестве значения передаётся массив)

  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки

  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:

    • "мол%" — ищем значения, начинающиеся с «мол»
    • "%мол" — ищем значения, заканчивающиеся на «мол»
    • "%мол%" — ищем значения, где «мол» может быть в любой позиции
  • %= — LIKE (см. описание выше)

  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.

  • =% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:

    • "мол%" — ищем значения, не начинающиеся с «мол»
    • "%мол" — ищем значения, не заканчивающиеся на «мол»
    • "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (см. описание выше)

  • = — равно, точное совпадение (используется по умолчанию)

  • != - не равно

  • ! — не равно

order
Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания

start
integer

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

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

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

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

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

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["*","UF_*"],"start":50,"filter":{"=OPPORTUNITY":15000},"order":{"STATUS_ID":"ASC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["*","UF_*"],"start":50,"filter":{"=OPPORTUNITY":15000},"order":{"STATUS_ID":"ASC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.lead.list',
            {
              select: ['*', 'UF_*'],
              filter: {
                '=OPPORTUNITY': 15000,
              },
              order: {
                STATUS_ID: 'ASC',
              },
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('crm.lead.list', {
            select: ['*', 'UF_*'],
            filter: {
              '=OPPORTUNITY': 15000,
            },
            order: {
              STATUS_ID: '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.
        
        try {
          const response = await $b24.callMethod('crm.lead.list', {
            select: ['*', 'UF_*'],
            filter: {
              '=OPPORTUNITY': 15000,
            },
            order: {
              STATUS_ID: 'ASC',
            },
          }, 50)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            $order = [];
            $filter = []; // Define your filter criteria here
            $select = [
                'ID', 'TITLE', 'HONORIFIC', 'NAME', 'SECOND_NAME', 'LAST_NAME', 
                'BIRTHDATE', 'COMPANY_TITLE', 'SOURCE_ID', 'SOURCE_DESCRIPTION', 
                'STATUS_ID', 'STATUS_DESCRIPTION', 'STATUS_SEMANTIC_ID', 'POST', 
                'ADDRESS', 'ADDRESS_2', 'ADDRESS_CITY', 'ADDRESS_POSTAL_CODE', 
                'ADDRESS_REGION', 'ADDRESS_PROVINCE', 'ADDRESS_COUNTRY', 
                'ADDRESS_COUNTRY_CODE', 'ADDRESS_LOC_ADDR_ID', 'CURRENCY_ID', 
                'OPPORTUNITY', 'IS_MANUAL_OPPORTUNITY', 'OPENED', 'COMMENTS', 
                'HAS_PHONE', 'HAS_EMAIL', 'HAS_IMOL', 'ASSIGNED_BY_ID', 
                'CREATED_BY_ID', 'MODIFY_BY_ID', 'MOVED_BY_ID', 'DATE_CREATE', 
                'DATE_MODIFY', 'MOVED_TIME', 'COMPANY_ID', 'CONTACT_ID', 
                'CONTACT_IDS', 'IS_RETURN_CUSTOMER', 'DATE_CLOSED', 
                'ORIGINATOR_ID', 'ORIGIN_ID', 'UTM_SOURCE', 'UTM_MEDIUM', 
                'UTM_CAMPAIGN', 'UTM_CONTENT', 'UTM_TERM', 'PHONE', 'EMAIL', 
                'WEB', 'IM', 'LINK'
            ];
            $startItem = 0;
            $leadsResult = $serviceBuilder->getCRMScope()->lead()->list($order, $filter, $select, $startItem);
            
            foreach ($leadsResult->getLeads() as $lead) {
                print("ID: {$lead->ID}, TITLE: {$lead->TITLE}, NAME: {$lead->NAME}, BIRTHDATE: " . 
                      ($lead->BIRTHDATE ? $lead->BIRTHDATE->format(DATE_ATOM) : 'N/A') . "\n");
            }
        } catch (Throwable $e) {
            print("Error: " . $e->getMessage());
        }
        
BX24.callMethod(
          'crm.lead.list',
          {
            select: ['*', 'UF_*'],
            filter: {
                '=OPPORTUNITY': 15000,
            },
            order: {
                STATUS_ID: 'ASC',
            }, 
          },
          (result) => {
            if(result.error())
            {
              console.error(result.error());
        
              return;
            }
            
            console.info(result.data());
        
            if (result.more())
            {
              result.next();
            }
          }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.list',
            [
                'select' => ['*', 'UF_*'],
                'start' => 50,
                'filter' => [
                    '=OPPORTUNITY' => 15000,
                ],
                'order' => [
                    'STATUS_ID' => 'ASC',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Некоторые практические примеры

BX24.callMethod(
            "crm.lead.list",
            {
                order: { "STATUS_ID": "ASC" },
                filter: { ">OPPORTUNITY": 0, "!STATUS_ID": "CONVERTED" },
                select: [ "ID", "TITLE", "STATUS_ID", "OPPORTUNITY", "CURRENCY_ID" ],
            },
            (result) => {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                    if (result.more())
                    {
                        result.next();
                    }
                }
            }
        );
        
BX24.callMethod(
            "crm.lead.list",
            {
                filter: { "PHONE": "555888" },
                select: [ "ID", "TITLE" ]
            },
            (result) => {
              if(result.error())
              {
                console.error(result.error());
              }
              else
              {
                console.dir(result.data());
                if (result.more())
                {
                  result.next();
                }
              }
            }
        );
        
$result = CRest::call(
            'crm.lead.list',
            [
                'filter' => [
                    '>DATE_CREATE' => '2023-10-01T00:00:00',
                    '<DATE_CREATE' => '2023-10-31T23:59:59',
                ],
                'select' => [
                    'ID',
                    'DATE_CREATE',
                ],
            ]
        );
        

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

HTTP-статус: 200

{
          "result": [
            {
              "ID": "5",
              "TITLE": "Лид 1",
              "HONORIFIC": null,
              "NAME": "Erasmus",
              "SECOND_NAME": null,
              "LAST_NAME": "Golden of Ireland",
              "COMPANY_TITLE": null,
              "COMPANY_ID": "0",
              "CONTACT_ID": "2069",
              "IS_RETURN_CUSTOMER": "N",
              "BIRTHDATE": "",
              "SOURCE_ID": "CALL",
              "SOURCE_DESCRIPTION": null,
              "STATUS_ID": "CONVERTED",
              "STATUS_DESCRIPTION": null,
              "POST": null,
              "COMMENTS": null,
              "CURRENCY_ID": "RUB",
              "OPPORTUNITY": "15000.00",
              "IS_MANUAL_OPPORTUNITY": "Y",
              "HAS_PHONE": "Y",
              "HAS_EMAIL": "Y",
              "HAS_IMOL": "N",
              "ASSIGNED_BY_ID": "1",
              "CREATED_BY_ID": "1",
              "MODIFY_BY_ID": "1",
              "DATE_CREATE": "2021-05-31T15:10:16+03:00",
              "DATE_MODIFY": "2021-11-26T18:56:13+03:00",
              "DATE_CLOSED": "2021-07-16T16:43:44+03:00",
              "STATUS_SEMANTIC_ID": "S",
              "OPENED": "Y",
              "ORIGINATOR_ID": null,
              "ORIGIN_ID": null,
              "MOVED_BY_ID": "1",
              "MOVED_TIME": "2021-07-16T16:43:44+03:00",
              "ADDRESS": "7677 Hollow Ridge Alley",
              "ADDRESS_2": null,
              "ADDRESS_CITY": null,
              "ADDRESS_POSTAL_CODE": null,
              "ADDRESS_REGION": null,
              "ADDRESS_PROVINCE": null,
              "ADDRESS_COUNTRY": "Indonesia",
              "ADDRESS_COUNTRY_CODE": null,
              "ADDRESS_LOC_ADDR_ID": "1",
              "UTM_SOURCE": null,
              "UTM_MEDIUM": null,
              "UTM_CAMPAIGN": null,
              "UTM_CONTENT": null,
              "UTM_TERM": null,
              "LAST_ACTIVITY_BY": "1",
              "LAST_ACTIVITY_TIME": "2021-05-31T15:10:16+03:00",
              "UF_CRM_1704817278": null,
              "UF_CRM_1706782596092": null,
              "UF_CRM_1708952993785": false
            },
            {
              "ID": "6",
              "TITLE": "Лид 2",
              "HONORIFIC": null,
              "NAME": "Ignacius",
              "SECOND_NAME": null,
              "LAST_NAME": "Slayny",
              "COMPANY_TITLE": null,
              "COMPANY_ID": "0",
              "CONTACT_ID": "2070",
              "IS_RETURN_CUSTOMER": "N",
              "BIRTHDATE": "",
              "SOURCE_ID": "CALL",
              "SOURCE_DESCRIPTION": null,
              "STATUS_ID": "CONVERTED",
              "STATUS_DESCRIPTION": null,
              "POST": null,
              "COMMENTS": null,
              "CURRENCY_ID": "RUB",
              "OPPORTUNITY": "15000.00",
              "IS_MANUAL_OPPORTUNITY": "Y",
              "HAS_PHONE": "Y",
              "HAS_EMAIL": "Y",
              "HAS_IMOL": "N",
              "ASSIGNED_BY_ID": "1",
              "CREATED_BY_ID": "1",
              "MODIFY_BY_ID": "1",
              "DATE_CREATE": "2021-05-31T15:10:16+03:00",
              "DATE_MODIFY": "2021-11-26T18:56:13+03:00",
              "DATE_CLOSED": "2021-07-16T16:43:47+03:00",
              "STATUS_SEMANTIC_ID": "S",
              "OPENED": "Y",
              "ORIGINATOR_ID": null,
              "ORIGIN_ID": null,
              "MOVED_BY_ID": "1",
              "MOVED_TIME": "2021-07-16T16:43:47+03:00",
              "ADDRESS": "35 Mosinee Street",
              "ADDRESS_2": null,
              "ADDRESS_CITY": null,
              "ADDRESS_POSTAL_CODE": null,
              "ADDRESS_REGION": null,
              "ADDRESS_PROVINCE": null,
              "ADDRESS_COUNTRY": "Japan",
              "ADDRESS_COUNTRY_CODE": null,
              "ADDRESS_LOC_ADDR_ID": "2",
              "UTM_SOURCE": null,
              "UTM_MEDIUM": null,
              "UTM_CAMPAIGN": null,
              "UTM_CONTENT": null,
              "UTM_TERM": null,
              "LAST_ACTIVITY_BY": "1",
              "LAST_ACTIVITY_TIME": "2021-05-31T15:10:16+03:00",
              "UF_CRM_1704817278": null,
              "UF_CRM_1706782596092": null,
              "UF_CRM_1708952993785": true
            },
            
              еще 48 лидов с аналогичной структурой
            
          ],
          "next": 50,
          "total": 654,
          "time": {
            "start": 1718292234.554781,
            "finish": 1718292234.657739,
            "duration": 0.10295796394348145,
            "processing": 0.05574321746826172,
            "date_start": "2024-06-13T18:23:54+03:00",
            "date_finish": "2024-06-13T18:23:54+03:00",
            "operating": 0
          }
        }
        

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

Название
тип

Описание

result
array

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

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

Для получения информации о структуре лида смотрите метод crm.lead.get

total
integer

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

next
integer

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

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

time
time

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

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

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

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Текст ошибки

Описание

Access denied

У пользователя нет прав на чтение лидов

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

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

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

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

Следующая