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

Контакты сделки

Привязывает контакты к сделке, читает их список и отвязывает по одному или все сразу. Связь хранит порядок контакта в списке и признак основного контакта. Сами контакты при отвязке остаются в CRM.

У сделки с контактами всегда один основной контакт. Его ID приходит в поле сделки contactId, ID всех привязанных — в поле contactIds. Поле contactIds только для чтения: PATCH /v1/deals/:id с ним отвечает 400 READONLY_FIELD, поэтому состав контактов меняют методы ниже.

Битрикс24 API: crm.deal.contact.items.get, crm.deal.contact.add, crm.deal.contact.items.set, crm.deal.contact.delete, crm.deal.contact.items.delete Скоуп: crm

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

GET /v1/deals/:id/contacts

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

Параметры

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

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

Примеры

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

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

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/deals/8785/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/deals/8785/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/deals/8785/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": 2921, "sort": 10, "isPrimary": false, "roleId": 0 },
    { "contactId": 2923, "sort": 20, "isPrimary": true, "roleId": 0 },
    { "contactId": 2925, "sort": 30, "isPrimary": false, "roleId": 0 }
  ]
}

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

404 — сделки с таким id нет:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Not found"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом, например abc
HTTP404 КодENTITY_NOT_FOUND ОписаниеСделки с таким id нет
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 из списка может не вести к контакту. Привязка не проверяет ID контакта, поэтому в списке бывает ID, которого нет среди контактов. Перед работой с контактом запросите его через GET /v1/contacts/:id.
  • Контакты вместе со сделкой. GET /v1/deals/:id?include=contact возвращает сделку и полные записи привязанных контактов в data._included.contacts. ID основного контакта приходит в поле сделки contactId, ID всех привязанных — в contactIds.

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