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

Получить событие

GET /v1/calendar-events/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID события
include (query) string нет Связанные сотрудники: owner, host, attendee. Подробнее — секция «Связанные данные» ниже

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/calendar-events/7773" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/calendar-events/7773" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { success, data } = await res.json()
console.log(data.name, '—', data.from)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Событие (все поля — см. Поля события)

Связанные данные

Получить сотрудников, связанных с событием, вместе с самим событием — параметр include в GET-запросе:

GET /v1/calendar-events/7773?include=owner,host,attendee

Доступные значения include — до трёх имён за запрос:

Имя По какому полю Ключ в _included Результат
owner ownerId — владелец календаря owner Карточка сотрудника или null
host meetingHost — организатор встречи host Карточка сотрудника или null. Для type: group карточка возвращается только при isMeeting: true, иначе _included.host равен null. У события без встречи meetingHost содержит ID рабочей группы. Создатель события указан в createdBy
attendee attendeeList — приглашённые users Массив карточек в порядке attendeeList. Без приглашённых — пустой массив

Карточка сотрудника та же, что в ответе GET /v1/users/:id. Связь читает сотрудника, поэтому ключу кроме calendar нужен скоуп user. Результат — в поле _included:

JSON 
{
  "success": true,
  "data": {
    "id": 7773,
    "name": "Созвон с командой",
    "ownerId": 1,
    "meetingHost": 1,
    "attendeeList": [
      { "id": 1, "entryId": "7773", "status": "H" }
    ],
    "_included": {
      "owner": { "id": 1, "name": "Иван", "lastName": "Петров", "email": "ivan.petrov@example.com", "active": true },
      "host": { "id": 1, "name": "Иван", "lastName": "Петров", "email": "ivan.petrov@example.com", "active": true },
      "users": [
        { "id": 1, "name": "Иван", "lastName": "Петров", "email": "ivan.petrov@example.com", "active": true }
      ]
    }
  }
}

Показаны основные поля события и сотрудника. Полный состав карточки — Поля сотрудника.

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

JSON 
{
  "success": true,
  "data": {
    "id": 7773,
    "parentId": 7773,
    "deleted": false,
    "type": "user",
    "ownerId": 1,
    "name": "Созвон с командой",
    "from": "2026-06-10T10:00:00+03:00",
    "to": "2026-06-10T11:00:00+03:00",
    "skipTime": false,
    "durationSeconds": 3600,
    "createdBy": 1,
    "dateCreate": "06/05/2026 09:12:00 am",
    "updatedAt": "06/05/2026 09:12:00 am",
    "description": "Еженедельная синхронизация",
    "accessibility": "busy",
    "importance": "normal",
    "isMeeting": false,
    "meetingStatus": "H",
    "meetingHost": 1,
    "sectionId": 3,
    "attendeeList": [
      { "id": 1, "entryId": "7773", "status": "H" }
    ],
    "crmFields": ["D_741", "C_9"]
  }
}

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

404 — событие не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "calendarEvent 99999999 not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Событие с указанным id не существует
400 INVALID_INCLUDE В include передано имя вне набора owner, host, attendee. Ответ перечисляет доступные имена
400 INCLUDE_LIMIT_EXCEEDED В include больше трёх имён
403 SCOPE_DENIED API-ключ не имеет скоупа calendar
403 SCOPE_DENIED В include запрошена связь на сотрудника, а у ключа нет скоупа user. Ответ называет связь и недостающий скоуп
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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