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

Компании контакта

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

У контакта с компаниями всегда одна основная компания. Её ID приходит в поле контакта companyId, ID всех привязанных компаний — в поле companyIds в порядке sort. Поле companyIds доступно для записи: PATCH /v1/contacts/:id с ним заменяет весь состав компаний так же, как PUT /v1/contacts/:id/companies. Компании, которых нет в массиве, отвязываются.

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

Список компаний контакта

GET /v1/contacts/:id/companies

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

Параметры

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

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

Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
const primary = data.find((link) => link.isPrimary)
console.log('Основная компания:', primary?.companyId)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/2943/companies', {
  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[].companyId Типnumber ОписаниеID компании. Получить компанию: GET /v1/companies/:id
Полеdata[].isPrimary Типboolean ОписаниеОсновная компания контакта. У контакта с компаниями true ровно у одной связи
Полеdata[].sort Типnumber ОписаниеПорядок компании в списке
Полеdata[].roleId Типnumber ОписаниеРоль связи. Методы связей её не сохраняют

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

JSON
{
  "success": true,
  "data": [
    { "companyId": 3099, "sort": 10, "isPrimary": false, "roleId": 0 },
    { "companyId": 3101, "sort": 20, "isPrimary": true, "roleId": 0 },
    { "companyId": 3103, "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
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, которого нет среди контактов, метод отвечает 200 с пустым data, как для контакта без компаний. Чтобы отличить эти случаи, запросите контакт через GET /v1/contacts/:id: для несуществующего контакта он отвечает 404 ENTITY_NOT_FOUND.
  • ID из списка может не вести к компании. Привязка не проверяет ID компании, поэтому в списке бывает ID, которого нет среди компаний. Перед работой с компанией запросите её через GET /v1/companies/:id.
  • Компании вместе с контактом. GET /v1/contacts/:id?include=companyBinding возвращает контакт и полные записи всех привязанных компаний в data._included.companyBindings, с include=company — только основную компанию в data._included.company. ID основной компании приходит в поле контакта companyId, ID всех привязанных — в companyIds.

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