Список привязок

GET /v1/activities/:activityId/bindings

Возвращает все CRM-сущности, к которым привязано дело. Минимум одна привязка есть всегда — сущность-владелец, указанная при создании дела.

Параметры

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

Примеры

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/activities/3631/bindings \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/activities/3631/bindings \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { data } = await res.json()
data.forEach(b => console.log(`${b.entityTypeId}:${b.entityId}`))

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

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

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив привязок
data[].entityTypeId number Числовой код типа CRM-сущности:
1 — лид
2 — сделка
3 — контакт
4 — компания
7 — предложение
31 — счёт
≥128 — смарт-процесс, его код — в `GET /v1/smart-processes`
data[].entityId number ID привязанной сущности

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

JSON 
{
  "success": true,
  "data": [
    { "entityTypeId": 2, "entityId": 4219 },
    { "entityTypeId": 3, "entityId": 9 }
  ]
}

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

404 — дело не существует:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS activityId не положительное целое число
404 ENTITY_NOT_FOUND Дела с указанным activityId не существует
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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