Получить лид

GET /v1/leads/:id

Возвращает лид по ID со всеми полями.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID лида

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/leads/42" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/leads/42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/42', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Лид:', data.title, '— статус:', data.stageId)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/42', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Объект лида со всеми полями — см. Поля лида.

Связанные данные

Запрос со связанными сущностями — параметр include:

GET /v1/leads/5001?include=contact,company

Доступные include: contact, company. Результат в поле _included. Подробнее — Связанные данные.

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 42,
    "title": "Заявка с сайта #42",
    "name": "Алексей",
    "lastName": "Иванов",
    "secondName": "Петрович",
    "stageId": "NEW",
    "companyTitle": "ООО Ромашка",
    "companyId": 15,
    "contactId": 71,
    "opportunity": 150000,
    "currencyId": "RUB",
    "sourceId": "WEB",
    "sourceDescription": "Форма обратной связи",
    "assignedById": 1,
    "createdBy": 1,
    "opened": true,
    "comments": "Звонить после 14:00",
    "phone": "+70000000001",
    "phoneWork": "+70000000001",
    "email": "info@example.com",
    "emailWork": "info@example.com",
    "emailHome": "home@example.com",
    "hasPhone": true,
    "hasEmail": true,
    "fm": [
      { "id": 41, "typeId": "PHONE", "valueType": "WORK", "value": "+70000000001" },
      { "id": 43, "typeId": "EMAIL", "valueType": "WORK", "value": "info@example.com" },
      { "id": 45, "typeId": "EMAIL", "valueType": "HOME", "value": "home@example.com" }
    ],
    "createdTime": "2026-04-10T14:30:00+03:00",
    "updatedTime": "2026-04-12T09:15:00+03:00"
  }
}

Телефон и почта в ответе — строки с первичным значением, значения по типам — в полях phoneWork, phoneMobile, emailWork, emailHome. Полный перечень с типами — в массиве fm[] ({ id, typeId, valueType, value }, где id — идентификатор записи). Наличие проверяйте по hasPhone/hasEmail: при отсутствии телефона phone приходит пустой строкой. Отдельную запись fm[] по её id через API не изменить и не удалить — PATCH добавляет новые записи.

Пример ответа при ошибке

404 — лид не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Лид не найден
403 ACCESS_DENIED Нет доступа к лиду
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Смотрите также