Получить дело

GET /v1/activity-configurable/:id

Возвращает конфигурируемое дело по ID: его поля и структуру оформления.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID дела. Получен при создании

Примеры

Примеры приведены только для OAuth-приложения.

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/activity-configurable/8053 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { data } = await res.json()
console.log(data.activity.fields.typeId, data.activity.layout)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.activity.id number ID дела
data.activity.ownerTypeId number Тип CRM-сущности:
1 — лид
2 — сделка
3 — контакт
4 — компания
7 — предложение
31 — счёт
≥128 — смарт-процесс, id типа — в `GET /v1/smart-processes`
data.activity.ownerId number ID сущности-владельца
data.activity.fields.typeId string Тип дела. Для дел без своего типа — CONFIGURABLE
data.activity.fields.completed boolean Дело закрыто
data.activity.fields.deadline string Крайний срок исполнения, ISO 8601. null, если не задан
data.activity.fields.pingOffsets number[] Смещения в минутах относительно deadline, в которые сформированы напоминания. Пустой массив, если напоминаний нет
data.activity.fields.isIncomingChannel boolean Дело создано из входящего канала
data.activity.fields.responsibleId number ID ответственного сотрудника
data.activity.fields.badgeCode string Код значка дела на канбане. Пустая строка, если не задан
data.activity.fields.originatorId string ID внешнего источника данных. null, если не задан
data.activity.fields.originId string ID записи во внешнем источнике. null, если не задан
data.activity.layout.icon object Иконка дела — поле code
data.activity.layout.header object Шапка — title. Битрикс24 может добавить пометки tags
data.activity.layout.body object Тело — логотип logo и именованные блоки blocks
data.activity.layout.footer object Футер — кнопки buttons и меню menu

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

JSON 
{
  "success": true,
  "data": {
    "activity": {
      "id": 8053,
      "ownerTypeId": 1,
      "ownerId": 2975,
      "fields": {
        "typeId": "CONFIGURABLE",
        "completed": false,
        "deadline": "2025-02-01T01:00:00+03:00",
        "pingOffsets": [],
        "isIncomingChannel": false,
        "responsibleId": 1,
        "badgeCode": "",
        "originatorId": null,
        "originId": null
      },
      "layout": {
        "icon": { "code": "call-completed" },
        "header": { "title": "Входящий звонок" },
        "body": { "logo": { "code": "call-incoming" }, "blocks": {} },
        "footer": { "buttons": {} }
      }
    }
  }
}

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

404 — дело не найдено:

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

Ошибки

HTTP Код Описание
400 VALIDATION_ERROR id в пути не является числом
404 ENTITY_NOT_FOUND Дела с указанным id не существует
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 TOKEN_MISSING Ключ авторизации передан без токена сессии в заголовке Authorization: Bearer

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

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

Только в контексте приложения. Нужен ключ авторизации vibe_app_* с токеном сессии в заголовке Authorization: Bearer. Персональный API-ключ vibe_api_* Битрикс24 отклоняет с ERROR_WRONG_CONTEXT.

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