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

Поля события

GET /v1/calendar-events/fields

Возвращает схему полей события: тип, признак readonly, доступные batch-операции.

Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data.fields).length)

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

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

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

Поля ответа

Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.

Поле Тип RO Описание
id number да ID события
parentId number да ID родительского события (для повторяющихся событий совпадает с id исходного)
active boolean да Активность события. Возвращается в списке GET /v1/calendar-events, в карточке GET /v1/calendar-events/:id отсутствует
deleted boolean да Признак удаления
name string Название
description string Описание
type string Тип календаря: user, group, company_calendar
ownerId number ID владельца календаря. Сотрудник: GET /v1/users
from datetime Начало (ISO 8601)
to datetime Окончание (ISO 8601)
skipTime boolean Событие на весь день. При true длительность фиксируется в 24 часа
durationSeconds number да Продолжительность события в секундах
importance string Важность: high, normal, low
accessibility string Занятость: busy, quest, free, absent
location string Место проведения
color string Цвет события (HEX)
textColor string Цвет текста события (HEX). Возвращается в списке GET /v1/calendar-events, в карточке GET /v1/calendar-events/:id отсутствует
sectionId number ID секции календаря
isPrivate boolean Приватное событие
isMeeting boolean Событие-встреча с приглашениями
attendees number[] Массив ID приглашённых сотрудников для записи. Только для записи — в ответах событий это поле не возвращается, участники доступны в attendeeList, attendeesCodes
attendeesCodes string[] да Внутренние коды участников Битрикс24 (формат U<id>)
attendeeList array да Расширенный список участников: { id, entryId, status }, где statusY (принято), H (хост), Q (под вопросом), N (отклонено)
remind array Настройки напоминаний
rrule object Расписание повторения регулярного события: периодичность (FREQ), интервал (INTERVAL), дни недели (BYDAY), граница серии (UNTIL или COUNT). На чтение BYDAY приходит объектом-словарём вида {"MO":"MO"}, а UNTIL — строка-дата в формате региональных настроек портала, которую Битрикс24 подставляет даже при заданном COUNT
crmFields string[] Элементы CRM, к которым привязано событие: D_<id> сделка, C_<id> контакт, L_<id> лид, CO_<id> компания. Списки элементов: GET /v1/deals, GET /v1/contacts, GET /v1/leads, GET /v1/companies. Событие без привязок отдаёт []. Снять все привязки пустым массивом можно на POST и PATCH; в батч-запросе пустой массив отклоняется: POST /v1/batchINVALID_PARAMS в data.errors под id вызова, POST /v1/calendar-events/batch400 BATCH_ITEM_VALIDATION на весь пакет (имя INVALID_PARAMS и индекс элемента внутри message)
createdBy number да ID создателя события. Поиск: GET /v1/users
dateCreate string да Дата создания. Строка в формате Битрикс24, зависящем от региональных настроек портала (например 08.06.2026 17:29:51 или 06/08/2026 05:29:51 pm). Это не ISO 8601 — не разбирать фиксированным парсером
updatedAt string да Дата последнего изменения. Строка в том же формате региональных настроек портала, что и dateCreate. Это не ISO 8601
meetingStatus string да Статус участия владельца календаря: Y (принято), H (хост), Q (под вопросом), N (отклонено)
meetingHost number да ID организатора встречи. Поиск: GET /v1/users
eventType string да Технический тип события (для системных событий)
syncStatus string да Статус синхронизации с внешними календарями
recurrenceId number да ID серии повторяющихся событий
collabId number да ID коллабораций (при участии внешних пользователей)
occurrenceIndex number да Порядковый номер вхождения в развёрнутой серии повторяющегося события, начинается с нуля. Строки серии делят один id — пара id + occurrenceIndex однозначно идентифицирует строку набора
version number да Монотонный счётчик изменений события — растёт при каждом изменении и не зависит от региональных настроек. Сравнивайте пары id + version, чтобы находить обновлённые события без разбора дат

Незаполненные скалярные поля возвращаются как null, пустые массивы — как []. В минимальном событии null приходит, например, в eventType, description, location, color, textColor, rrule, recurrenceId, syncStatus, collabId, а remind приходит пустым массивом [].

Полей dateFrom / dateTo не существует — начало и окончание события лежат в from / to. Исходные имена Битрикс24 DATE_FROM / DATE_TO принимаются в select как алиасы и проецируют канонические from / to. Незнакомое имя в select на этой сущности отвечает 400 UNKNOWN_SELECT_FIELD с перечнем допустимых имён.

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

JSON
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID события", "description": "Уникальный идентификатор события календаря." },
      "name": { "type": "string", "readonly": false, "label": "Название", "description": "Название события календаря." },
      "type": { "type": "string", "readonly": false, "label": "Тип календаря", "description": "Тип календаря события: пользовательский, групповой или общий календарь компании." },
      "ownerId": { "type": "number", "readonly": false, "label": "ID владельца календаря", "description": "Идентификатор владельца календаря — сотрудника или рабочей группы." },
      "from": { "type": "datetime", "readonly": false, "label": "Начало события", "description": "Дата и время начала события в формате ISO 8601 со смещением часового пояса." },
      "to": { "type": "datetime", "readonly": false, "label": "Окончание события", "description": "Дата и время окончания события в формате ISO 8601 со смещением часового пояса." },
      "skipTime": { "type": "boolean", "readonly": false, "label": "Событие на весь день", "description": "Признак того, что событие длится весь день без учёта конкретного времени." },
      "durationSeconds": { "type": "number", "readonly": true, "label": "Длительность в секундах", "description": "Продолжительность события в секундах." },
      "importance": { "type": "string", "readonly": false, "label": "Важность", "description": "Уровень важности события: высокий, обычный или низкий." },
      "accessibility": { "type": "string", "readonly": false, "label": "Занятость", "description": "Статус занятости владельца на время события: занят, под вопросом, свободен или отсутствует." },
      "sectionId": { "type": "number", "readonly": false, "label": "ID секции календаря", "description": "Идентификатор секции календаря, в которую записано событие." },
      "attendees": { "type": "array", "readonly": false, "label": "Приглашённые участники", "description": "Массив ID сотрудников, приглашаемых на событие — поле только для записи; в ответе участники возвращаются в attendeeList и attendeesCodes." },
      "rrule": { "type": "object", "readonly": false, "label": "Правило повторения", "description": "Расписание повторения регулярного события: периодичность, интервал, дни недели и условие окончания серии." },
      "crmFields": { "type": "array", "readonly": false, "label": "Элементы CRM", "description": "Элементы CRM, к которым привязано событие, — массив типизированных ссылок: `D_<id>` сделка, `C_<id>` контакт, `L_<id>` лид, `CO_<id>` компания. На создании и обновлении значение обязано быть массивом. Пустой массив снимает все привязки, а отсутствие поля сохраняет уже записанные; очистка работает только на POST и PATCH — в батч-запросе пустой массив отклоняется: `POST /v1/batch` отвечает `INVALID_PARAMS` в `data.errors` под `id` этого вызова, `POST /v1/calendar-events/batch` — `400 BATCH_ITEM_VALIDATION` на весь пакет (имя `INVALID_PARAMS` и индекс элемента приходят внутри `message`). Событие без привязок читается как `[]`. Неизвестный префикс или ссылка на несуществующую запись отклоняются." },
      "dateCreate": { "type": "string", "readonly": true, "label": "Дата создания", "description": "Дата и время создания события в строковом формате, зависящем от региональных настроек портала." },
      "updatedAt": { "type": "string", "readonly": true, "label": "Дата изменения", "description": "Дата и время последнего изменения события в строковом формате, зависящем от региональных настроек портала." },
      "occurrenceIndex": { "type": "number", "readonly": true, "label": "Номер вхождения", "description": "Порядковый номер (с нуля) вхождения в развёрнутой серии повторяющегося события. Повторяющиеся события возвращаются отдельной строкой на каждое вхождение с одним и тем же id — пара (id, occurrenceIndex) однозначно идентифицирует строку." },
      "version": { "type": "number", "readonly": true, "label": "Версия изменений", "description": "Монотонный счётчик изменений на стороне Битрикс24 — растёт при каждом изменении события. Локале-независимый маркер изменения: сравнивайте пары (id, version), чтобы находить обновлённые события без разбора дат." }
    },
    "batch": ["create", "update", "delete"]
  }
}

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

403 — нет скоупа:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'calendar' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа calendar
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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