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

Получить связь реквизитов

GET /v1/requisite-links/:entityTypeId/:entityId

Возвращает конкретную связь реквизитов по паре идентификаторов владельца.

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да Тип владельца связи. Значения — Поля связи
entityId (path) number да ID владельца. Источник зависит от типа — см. тот же справочник

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-links/2/3773" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-links/2/3773" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const entityTypeId = 2
const entityId = 3773

const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/requisite-links/${entityTypeId}/${entityId}`,
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } },
)

const { success, data } = await res.json()
console.log('Реквизит клиента:', data.requisiteId)

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

javascript 
const entityTypeId = 2
const entityId = 3773

const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/requisite-links/${entityTypeId}/${entityId}`,
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
)

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект связи
data.entityTypeId number Тип владельца. Значения — Поля связи
data.entityId number ID владельца
data.requisiteId number ID привязанного реквизита клиента, 0 — не привязан. Источник: GET /v1/requisites
data.bankDetailId number ID привязанного банковского реквизита клиента, 0 — не привязан. Источник: GET /v1/bank-details
data.mcRequisiteId number ID реквизита вашей компании, 0 — не привязан
data.mcBankDetailId number ID банковского реквизита вашей компании, 0 — не привязан

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

JSON 
{
  "success": true,
  "data": {
    "entityTypeId": 2,
    "entityId": 3773,
    "requisiteId": 45,
    "bankDetailId": 0,
    "mcRequisiteId": 0,
    "mcBankDetailId": 0
  }
}

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

404 — связи для этой пары нет:

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

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Битрикс24 вернул ошибку «не найдено»: связи для пары entityTypeId и entityId нет, либо самой сущности-владельца не существует
404 NOT_FOUND Битрикс24 вернул пустой результат вместо ошибки — связи для этой пары нет
400 INVALID_ANCHOR entityTypeId или entityId в пути не положительное целое число
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

У связи нет отдельного числового id. Она определяется парой значений владельца — entityTypeId и entityId, оба передаются в пути.

Отсутствие связи и отсутствие привязок — разные состояния. Если связь не заводили, ответ 404. Если связь заведена, но ни один реквизит к ней не привязан, ответ 200, а все четыре идентификатора равны 0.

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