Получить лид по Id crm.lead.get

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

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

Scope: crm

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

DEPRECATED

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

Метод crm.lead.get возвращает лид по идентификатору.

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

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

Название
тип

Описание

id*
integer

Идентификатор лида.

Идентификатор можно получить с помощью методов crm.lead.list или crm.lead.add

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

Python

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":123}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":123,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.get

// 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
        
        type CrmLeadMultifield = {
          ID: string
          VALUE_TYPE: string
          VALUE: string
          TYPE_ID: string
        }
        
        // Shape of the payload returned in result (a representative subset of the documented lead fields)
        type CrmLead = {
          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
          PHONE?: CrmLeadMultifield[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmLead>({
            method: 'crm.lead.get',
            params: {
              id: 123,
            },
            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('Lead title:', result.TITLE, 'status:', result.STATUS_ID)
          }
        } 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 getLead() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.lead.get',
                params: {
                  id: 123,
                },
                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('Lead title:', result.TITLE, 'status:', result.STATUS_ID)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getLead)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.lead.get',
                    [
                        'id' => 123,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                return;
            }
        
            echo 'Lead data: ' . print_r($result->data(), true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting lead data: ' . $e->getMessage();
        }

BX24.callMethod(
          'crm.lead.get',
          { id: 123 },
          (result) => {
            if(result.error())
            {
              console.error(result.error());
        
              return;
            }
            
            console.info(result.data());
          }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.get',
            [
                'ID' => 123
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Пример

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.lead.get(
                bitrix_id=1201,
            ).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}")

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

HTTP-статус: 200

{
          "result": {
            "ID": "123",
            "TITLE": "Лид #1591",
            "HONORIFIC": null,
            "NAME": "",
            "SECOND_NAME": null,
            "LAST_NAME": null,
            "COMPANY_TITLE": null,
            "COMPANY_ID": null,
            "CONTACT_ID": null,
            "IS_RETURN_CUSTOMER": "N",
            "BIRTHDATE": "",
            "SOURCE_ID": "1",
            "SOURCE_DESCRIPTION": null,
            "STATUS_ID": "IN_PROCESS",
            "STATUS_DESCRIPTION": null,
            "POST": null,
            "COMMENTS": null,
            "CURRENCY_ID": "RUB",
            "OPPORTUNITY": "0.00",
            "IS_MANUAL_OPPORTUNITY": "N",
            "HAS_PHONE": "N",
            "HAS_EMAIL": "N",
            "HAS_IMOL": "N",
            "ASSIGNED_BY_ID": "1",
            "CREATED_BY_ID": "1",
            "MODIFY_BY_ID": "1",
            "DATE_CREATE": "2024-05-23T18:18:25+03:00",
            "DATE_MODIFY": "2024-05-23T18:18:25+03:00",
            "DATE_CLOSED": "",
            "STATUS_SEMANTIC_ID": "P",
            "OPENED": "Y",
            "ORIGINATOR_ID": null,
            "ORIGIN_ID": null,
            "MOVED_BY_ID": "1",
            "MOVED_TIME": "2024-05-23T18:18:25+03:00",
            "ADDRESS": null,
            "ADDRESS_2": null,
            "ADDRESS_CITY": null,
            "ADDRESS_POSTAL_CODE": null,
            "ADDRESS_REGION": null,
            "ADDRESS_PROVINCE": null,
            "ADDRESS_COUNTRY": null,
            "ADDRESS_COUNTRY_CODE": null,
            "ADDRESS_LOC_ADDR_ID": null,
            "UTM_SOURCE": null,
            "UTM_MEDIUM": null,
            "UTM_CAMPAIGN": null,
            "UTM_CONTENT": null,
            "UTM_TERM": null,
            "LAST_ACTIVITY_BY": "1",
            "LAST_ACTIVITY_TIME": "2024-05-23T18:18:25+03:00",
            "PHONE": [
              {
                "ID": "11658",
                "VALUE_TYPE": "OTHER",
                "VALUE": "+5454777777",
                "TYPE_ID": "PHONE"
              }
            ],
            "IM": [
              {
                "ID": "11660",
                "VALUE_TYPE": "OPENLINE",
                "VALUE": "imol|livechat|1|67|21",
                "TYPE_ID": "IM"
              }
            ]
          },
          "time": {
              "start": 1705764932.998683,
              "finish": 1705764937.173995,
              "duration": 4.1753120422363281,
              "processing": 3.3076529502868652,
              "date_start": "2024-01-20T18:35:32+03:00",
              "date_finish": "2024-01-20T18:35:37+03:00",
              "operating_reset_at": 1705765533,
              "operating": 3.3076241016387939
          }
        }

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

Название `тип`	Описание
result `lead`	Корневой элемент ответа. Содержит информацию о полях лида. Структура описана ниже
time `time`	Информация о времени выполнения запроса

Тип lead

Название `тип`	Описание
ID `integer`	Целочисленный идентификатор лида
TITLE `string`	Название лида
HONORIFIC `crm_status`	Вид обращения. Статус из справочника. Список возможных идентификаторов можно получить методом crm.status.list с фильтром `filter[ENTITY_ID]=HONORIFIC`
NAME `string`	Имя контакта
SECOND_NAME `string`	Отчество контакта
LAST_NAME `string`	Фамилия контакта
COMPANY_ID `crm_company`	Привязка лида к компании
COMPANY_TITLE `string`	Название компании
CONTACT_ID `crm_contact`	Привязка лида к контакту
IS_RETURN_CUSTOMER `char`	Признак повторного лида. Допустимые значения Y или N
BIRTHDATE `date`	Дата рождения
SOURCE_ID `crm_status`	Идентификатор источника. Статус из справочника. Список возможных идентификаторов можно получить методом crm.status.list с фильтром `filter[ENTITY_ID]=SOURCE`
SOURCE_DESCRIPTION `string`	Описание источника
STATUS_ID `crm_status`	Идентификатор стадии лида. Статус из справочника. Список возможных идентификаторов можно получить методом crm.status.list с фильтром `filter[ENTITY_ID]=STATUS`
STATUS_DESCRIPTION `string`	Дополнительно о стадии
POST `string`	Должность
COMMENTS `string`	Комментарии
CURRENCY_ID `crm_currency`	Идентификатор валюты
OPPORTUNITY `double`	Предполагаемая сумма
IS_MANUAL_OPPORTUNITY `char`	Признак ручного расчёта суммы. Допустимые значения Y или N
HAS_PHONE `char`	Признак заполненности поля телефон. Допустимые значения Y или N
HAS_EMAIL `char`	Признак заполненности поля электронной почты. Допустимые значения Y или N
HAS_IMOL `char`	Признак наличия привязанной открытой линии. Допустимые значения Y или N
ASSIGNED_BY_ID `user`	Идентификатор пользователя ответственного за лид
CREATED_BY_ID `user`	Идентификатор пользователя создавшего лид
MODIFY_BY_ID `user`	Идентификатор пользователя-автора последнего изменения
MOVED_BY_ID `user`	Идентификатор пользователя-автора перемещения элемента на текущую стадию
DATE_CREATE `datetime`	Дата создания
DATE_MODIFY `datetime`	Дата изменения
DATE_CLOSED `datetime`	Дата закрытия
STATUS_SEMANTIC_ID `string`	F (failed) – обработан неуспешно S (success) – обработан успешно P (processing) – лид в обработке
OPENED `char`	Признак доступности лида для всех. Допустимые значения Y или N
ORIGINATOR_ID `string`	Идентификатор источника данных. Используется только для привязки к внешнему источнику
ORIGIN_ID `string`	Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику
MOVED_TIME `datetime`	Дата перемещения элемента на текущую стадию
ADDRESS `string`	Адрес контакта
ADDRESS_2 `string`	Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части
ADDRESS_CITY `string`	Город
ADDRESS_POSTAL_CODE `string`	Почтовый индекс
ADDRESS_REGION `string`	Район
ADDRESS_PROVINCE `string`	Область
ADDRESS_COUNTRY `string`	Страна
ADDRESS_COUNTRY_CODE `string`	Код страны
ADDRESS_LOC_ADDR_ID `string`	Используется для служебных целей
UTM_SOURCE `string`	Рекламная система. Yandex-Direct, Google-Adwords и другие
UTM_MEDIUM `string`	Тип трафика. CPC (объявления), CPM (баннеры)
UTM_CAMPAIGN `string`	Обозначение рекламной кампании
UTM_CONTENT `string`	Содержание кампании. Например, для контекстных объявлений
UTM_TERM `string`	Условие поиска кампании. Например, ключевые слова контекстной рекламы
LAST_ACTIVITY_BY `string`	Идентификатор пользователя ответственного за последнюю активность в этом лиде (например, создавшего новое дело в лиде)
LAST_ACTIVITY_TIME `datetime`	Время последней активности
UF_...	Пользовательские поля. Например, `UF_CRM_25534736`. В зависимости от настроек портала у лидов может быть набор пользовательских полей определенных типов. Для создания, изменения или удаления пользовательских полей в лидах используйте методы crm.lead.userfield.*
PHONE `crm_multifield`	Массив телефонов
IM `crm_multifield`	Массив мессенджеров

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

40x, 50x Error

{
            "error": "",
            "error_description": "Not found"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Текст ошибки	Описание
`ID is not defined or invalid`	В параметр `id` либо не передано значение, либо оно является не целым числом больше нуля
`Not found`	Лид с указанным `id` не найден
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить дело в новый лид или сделку в зависимости от режима CRM

Изменить лид

Получить список лидов

Получить лид по Id crm.lead.get

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

Примеры кодаПримеры кода

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

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

Тип leadТип lead

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

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

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

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