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

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

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

Признак isPrimary у связи значит, что эта компания основная у контакта: её ID приходит в поле контакта companyId. Привязка и замена делают компанию основной у каждого переданного контакта. ID всех привязанных контактов приходят в поле компании contactIds.

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

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

GET /v1/companies/:id/contacts

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

Параметры

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

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

Примеры

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

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

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

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

const { success, data } = await res.json()
const contactIds = data.map((link) => link.contactId)
console.log('Контакты компании:', contactIds)

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

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

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

JSON
{
  "success": true,
  "data": [
    { "contactId": 2987, "sort": 10, "isPrimary": true, "roleId": 0 },
    { "contactId": 2989, "sort": 20, "isPrimary": true, "roleId": 0 },
    { "contactId": 2991, "sort": 30, "isPrimary": true, "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/companies/:id: на такой ID он отвечает 404.
  • ID из списка может не вести к контакту. Привязка не проверяет ID контакта, поэтому в списке бывает ID, которого нет среди контактов. Перед работой с контактом запросите его через GET /v1/contacts/:id.
  • Контакты вместе с компанией. GET /v1/companies/:id?include=contact возвращает компанию и полные записи привязанных контактов в data._included.contacts. Значение include — contact в единственном числе: include=contacts отвечает 400 INVALID_INCLUDE. ID всех привязанных контактов приходят в поле компании contactIds.

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