метод REST
scope: crm
Устаревший
crm.lead.get
Получить лид по Id
Устаревший метод.
Развитие метода остановлено. Используйте crm.item.get.
Описание
Метод crm.lead.get возвращает лид по идентификатору.
Параметры
id
integer
обязательный
Идентификатор лида.
Идентификатор можно получить с помощью методов crm.lead.list или crm.lead.add
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.lead.get", b24.Params{
"id": 123,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.lead.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
Title string `json:"TITLE"`
Name string `json:"NAME"`
IsReturnCustomer string `json:"IS_RETURN_CUSTOMER"`
Birthdate string `json:"BIRTHDATE"`
SourceID b24.ID `json:"SOURCE_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title)
Ответ
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
Информация о времени выполнения запроса
Обработка ошибок
{
"error": "",
"error_description": "Not found"
}

