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

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

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

Scope: crm

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

DEPRECATED

Развитие метода остановлено. Используйте метод REST 3.0 crm.lead.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
// 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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each lead object returned in result[]
type CrmLeadListItem = {
  ID: string
  TITLE: string
  NAME: string | null
  LAST_NAME: string | null
  STATUS_ID: string
  SOURCE_ID: string
  CURRENCY_ID: string
  OPPORTUNITY: string
  ASSIGNED_BY_ID: string
  OPENED: string
  DATE_CREATE: ISODate | null
  DATE_MODIFY: ISODate | null
}

try {
  // crm.lead.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<CrmLeadListItem[]>({
    method: 'crm.lead.list',
    params: {
      select: ['*', 'UF_*'],
      filter: {
        '=OPPORTUNITY': 15000,
      },
      order: {
        STATUS_ID: 'ASC',
      },
      start: 50,
    },
    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('Leads 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 listLeads() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // crm.lead.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.lead.list',
        params: {
          select: ['*', 'UF_*'],
          filter: {
            '=OPPORTUNITY': 15000,
          },
          order: {
            STATUS_ID: 'ASC',
          },
          start: 50,
        },
        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('Leads on this page:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listLeads)
</script>

Пример

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.lead.list(
        select=["ID", "TITLE", "STATUS_ID", "OPPORTUNITY", "CURRENCY_ID", "ASSIGNED_BY_ID", "DATE_CREATE"],
        filter={">OPPORTUNITY": 0, "!STATUS_ID": "CONVERTED", "=OPENED": "Y"},
        order={"DATE_CREATE": "DESC", "ID": "DESC"},
        start=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

Пример as_list

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.lead.list(
        select=["ID", "TITLE", "STATUS_ID"],
        filter={"!STATUS_ID": "JUNK"},
        order={"ID": "ASC"},
    ).as_list().response
    result = bitrix_response.result
    for item in result:
        print(item)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

Пример as_list_fast

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.lead.list(
        select=["ID", "TITLE", "STATUS_ID"],
        filter={"!STATUS_ID": "JUNK"},
        order={"ID": "DESC"},
    ).as_list_fast(descending=True).response
    result = bitrix_response.result
    for item in result:
        print(item)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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
string

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

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

Текст ошибки

Описание

Access denied

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

Следующая