Для AI-агентов: markdown этой страницы — /docs-content/entities/leads/contacts-list.md индекс документации — /llms.txt

Список контактов лида

GET /v1/leads/:id/contacts

Возвращает связи лида с контактами: ID контакта, порядок и признак основного, чтобы перед правкой состава знать, кто привязан.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID лида. Список: GET /v1/leads

Пагинации нет: ответ содержит все связи лида за один вызов.

Примеры

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

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

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -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/1001321/contacts', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
const primary = data.find((link) => link.isPrimary)
console.log('Основной контакт:', primary?.contactId)

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеСвязи лида с контактами в порядке sort. У лида без контактов и у несуществующего лида — пустой массив
Полеdata[].contactId Типnumber ОписаниеID контакта. Получить контакт: GET /v1/contacts/:id
Полеdata[].isPrimary Типboolean ОписаниеОсновной контакт лида. У лида с контактами true ровно у одной связи
Полеdata[].sort Типnumber ОписаниеПорядок контакта в списке
Полеdata[].roleId Типnumber ОписаниеРоль контакта в лиде. Методы связей её не сохраняют

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

JSON
{
  "success": true,
  "data": [
    { "contactId": 2937, "sort": 10, "isPrimary": false, "roleId": 0 },
    { "contactId": 2939, "sort": 20, "isPrimary": true, "roleId": 0 },
    { "contactId": 2941, "sort": 30, "isPrimary": false, "roleId": 0 }
  ]
}

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

400 — id не является положительным целым числом:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive integer"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом, например abc или 0
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеК ключу не привязаны токены Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен. Повторите запрос позже

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

Известные особенности

  • Пустой список не доказывает, что лид есть. Для удалённого лида и для ID, которого не было, ответ тот же, что у лида без контактов. Существование лида проверяйте через GET /v1/leads/:id: для несуществующего лида он отвечает 404.
  • ID из списка может не вести к контакту. Привязка не проверяет ID контакта, поэтому в списке бывает ID, которого нет среди контактов. Перед работой с контактом запросите его через GET /v1/contacts/:id.
  • Контакты вместе с лидом. GET /v1/leads/:id?include=contactBinding возвращает лид и полные записи привязанных контактов в data._included.contactBindings. С include=contact в data._included.contact приходит один объект — основной контакт. ID основного контакта приходит в поле лида contactId, ID всех привязанных — в contactIds.

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