Получить список будущих событий calendar.event.get.nearest

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: calendar

Кто может выполнять метод: любой пользователь

Метод calendar.event.get.nearest получает список ближайших будущих событий календаря за заданное число дней.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

type
string

Тип календаря:

  • user — календарь пользователя
  • group — календарь группы
  • company_calendar — календарь компании

ownerId
integer

Идентификатор владельца календаря.

Передавайте ownerId вместе с type. Значение параметра не влияет на список
возвращаемых событий. Для календаря компании передайте значение 0

days
integer

Число дней для выборки, начиная с текущей даты. По умолчанию — 60

forCurrentUser
boolean

Вывод списка событий для текущего пользователя. По умолчанию — true

maxEventsCount
integer

Максимальное число выводимых событий. По умолчанию ограничения нет

detailUrl
string

Шаблон ссылки на календарь, например /company/personal/user/#user_id#/calendar/. Метод подставит идентификатор текущего пользователя вместо #user_id#, отбросит часть ссылки после ? и добавит параметры события.

Если параметр передан, у каждого события в ответе появится поле ~detailUrl со ссылкой на событие

Примечание

Чтобы выбрать тип календаря, передайте type и ownerId вместе. Значение ownerId
не влияет на список возвращаемых событий. Для календаря компании передайте
type: company_calendar и ownerId: 0.

Если передан forCurrentUser: true или не заданы type и ownerId, метод принудительно
переключается на календарь текущего пользователя: type: user и forCurrentUser: true.

Примеры кода

Как использовать примеры в документации

  1. Получить события текущего пользователя за следующие 10 дней.

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"type":"user","ownerId":2,"days":10,"forCurrentUser":true,"maxEventsCount":100,"detailUrl":"/company/personal/user/#user_id#/calendar/"}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.get.nearest
    
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"type":"user","ownerId":2,"days":10,"forCurrentUser":true,"maxEventsCount":100,"detailUrl":"/company/personal/user/#user_id#/calendar/","auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/calendar.event.get.nearest
    
    // This snippet is an ES module: top-level await requires type="module" or a bundler.
    // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
    import { Text } from '@bitrix24/b24jssdk'
    import type { B24Frame } from '@bitrix24/b24jssdk'
    
    declare const $b24: B24Frame
    
    // Shape of the payload returned in result (match the "response handling" section of the page)
    type CalendarEventItem = {
      ID: string
      NAME: string
      DATE_FROM: string
      DATE_TO: string
      TIMESTAMP_X_ISO?: string
      DELETED: string
    }
    
    try {
      const response = await $b24.actions.v2.call.make<CalendarEventItem[]>({
        method: 'calendar.event.get.nearest',
        params: {
        type: 'user',
        ownerId: 2,
        days: 10,
        forCurrentUser: true,
        maxEventsCount: 100,
        detailUrl: '/company/personal/user/#user_id#/calendar/',
        },
        requestId: Text.getUuidRfc4122()
      })
    
      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
      } else {
        const events = response.getData()!.result
        events.forEach((event) => console.info('Event:', event.ID, event.NAME, event.DATE_FROM, event.DATE_TO))
      }
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
    
    <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
    <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
    <script>
      async function getNearestCalendarEvents() {
        try {
          // Initialize the SDK inside a Bitrix24 frame
          const $b24 = await B24Js.initializeB24Frame()
    
          const response = await $b24.actions.v2.call.make({
            method: 'calendar.event.get.nearest',
            params: {
              type: 'user',
              ownerId: 2,
              days: 10,
              forCurrentUser: true,
              maxEventsCount: 100,
              detailUrl: '/company/personal/user/#user_id#/calendar/',
            },
            requestId: B24Js.Text.getUuidRfc4122()
          })
    
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
            return
          }
    
          const events = response.getData().result
          events.forEach((event) => console.info('Event:', event.ID, event.NAME, event.DATE_FROM, event.DATE_TO))
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
      }
    
      document.addEventListener('DOMContentLoaded', getNearestCalendarEvents)
    </script>
    
    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
    
    try:
        bitrix_response = client.calendar.event.get.nearest(
            type="user",
            owner_id=2,
            days=10,
            for_current_user=True,
            max_events_count=100,
            detail_url="/company/personal/user/#user_id#/calendar/",
        ).response
        result = bitrix_response.result
        print(result)
    except BitrixAPIError as error:
        print(
            "Ошибка Bitrix API",
            f"error: {error.error}",
            f"error_description: {error.error_description}",
            sep="\n",
        )
    except BitrixSDKException as error:
        print(f"Ошибка Bitrix SDK: {error.message}")
    except Exception as error:
        print(f"Непредвиденная ошибка: {error}")
    
    try {
        $response = $b24Service
            ->core
            ->call(
                'calendar.event.get.nearest',
                [
                    'type'           => 'user',
                    'ownerId'        => 2,
                    'days'           => 10,
                    'forCurrentUser' => true,
                    'maxEventsCount' => 100,
                    'detailUrl'      => '/company/personal/user/#user_id#/calendar/',
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting calendar events: ' . $e->getMessage();
    }
    
    BX24.callMethod(
        'calendar.event.get.nearest',
        {
            type: 'user',
            ownerId: 2,
            days: 10,
            forCurrentUser: true,
            maxEventsCount: 100,
            detailUrl: '/company/personal/user/#user_id#/calendar/'
        }
    );
    
    require_once('crest.php');
    
    $result = CRest::call(
        'calendar.event.get.nearest',
        [
            'type' => 'user',
            'ownerId' => 2,
            'days' => 10,
            'forCurrentUser' => true,
            'maxEventsCount' => 100,
            'detailUrl' => '/company/personal/user/#user_id#/calendar/'
        ]
    );
    
    echo '<PRE>';
    print_r($result);
    echo '</PRE>';
    
    // client и ctx уже созданы — см. раздел «SDK для Go»
    res, err := client.Core().Call(ctx, "calendar.event.get.nearest", b24.Params{
    	"type":           "user",
    	"ownerId":        2,
    	"days":           10,
    	"forCurrentUser": true,
    	"maxEventsCount": 100,
    	"detailUrl":      "/company/personal/user/#user_id#/calendar/",
    })
    if err != nil {
    	return fmt.Errorf("calendar.event.get.nearest: %w", err)
    }
    
    // Ответ приходит как json.RawMessage — разберите его
    // в структуру под форму ответа, показанную ниже на этой странице.
    fmt.Printf("%s\n", res.Result)
    
  2. Получить события календаря компании.

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"type":"company_calendar","ownerId":0,"forCurrentUser":false}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.get.nearest
    
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"type":"company_calendar","ownerId":0,"forCurrentUser":false,"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/calendar.event.get.nearest
    
    // This snippet is an ES module: top-level await requires type="module" or a bundler.
    // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
    import { Text } from '@bitrix24/b24jssdk'
    import type { B24Frame } from '@bitrix24/b24jssdk'
    
    declare const $b24: B24Frame
    
    // Shape of the payload returned in result (match the "response handling" section of the page)
    type CalendarEventItem = {
      ID: string
      NAME: string
      DATE_FROM: string
      DATE_TO: string
      TIMESTAMP_X_ISO?: string
      DELETED: string
    }
    
    try {
      const response = await $b24.actions.v2.call.make<CalendarEventItem[]>({
        method: 'calendar.event.get.nearest',
        params: {
        type: 'company_calendar',
        ownerId: 0,
        forCurrentUser: false,
        },
        requestId: Text.getUuidRfc4122()
      })
    
      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
      } else {
        const events = response.getData()!.result
        events.forEach((event) => console.info('Event:', event.ID, event.NAME, event.DATE_FROM, event.DATE_TO))
      }
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
    
    <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
    <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
    <script>
      async function getNearestCalendarEvents() {
        try {
          // Initialize the SDK inside a Bitrix24 frame
          const $b24 = await B24Js.initializeB24Frame()
    
          const response = await $b24.actions.v2.call.make({
            method: 'calendar.event.get.nearest',
            params: {
              type: 'company_calendar',
              ownerId: 0,
              forCurrentUser: false,
            },
            requestId: B24Js.Text.getUuidRfc4122()
          })
    
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
            return
          }
    
          const events = response.getData().result
          events.forEach((event) => console.info('Event:', event.ID, event.NAME, event.DATE_FROM, event.DATE_TO))
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
      }
    
      document.addEventListener('DOMContentLoaded', getNearestCalendarEvents)
    </script>
    
    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
    
    try:
        bitrix_response = client.calendar.event.get.nearest(
            type="company_calendar",
            owner_id=0,
            for_current_user=False,
        ).response
        result = bitrix_response.result
        print(result)
    except BitrixAPIError as error:
        print(
            "Ошибка Bitrix API",
            f"error: {error.error}",
            f"error_description: {error.error_description}",
            sep="\n",
        )
    except BitrixSDKException as error:
        print(f"Ошибка Bitrix SDK: {error.message}")
    except Exception as error:
        print(f"Непредвиденная ошибка: {error}")
    
    try {
        $response = $b24Service
            ->core
            ->call(
                'calendar.event.get.nearest',
                [
                    'type'           => 'company_calendar',
                    'ownerId'        => 0,
                    'forCurrentUser' => false,
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting calendar events: ' . $e->getMessage();
    }
    
    BX24.callMethod(
        'calendar.event.get.nearest',
        {
            type: 'company_calendar',
            ownerId: 0,
            forCurrentUser: false
        }
    );
    
    require_once('crest.php');
    
    $result = CRest::call(
        'calendar.event.get.nearest',
        [
            'type' => 'company_calendar',
            'ownerId' => 0,
            'forCurrentUser' => false
        ]
    );
    
    echo '<PRE>';
    print_r($result);
    echo '</PRE>';
    
    // client и ctx уже созданы — см. раздел «SDK для Go»
    res, err := client.Core().Call(ctx, "calendar.event.get.nearest", b24.Params{
    	"type":           "company_calendar",
    	"ownerId":        0,
    	"forCurrentUser": false,
    }, b24.WithIdempotent())
    if err != nil {
    	return fmt.Errorf("calendar.event.get.nearest: %w", err)
    }
    
    // Ответ приходит как json.RawMessage — разберите его
    // в структуру под форму ответа, показанную ниже на этой странице.
    fmt.Printf("%s\n", res.Result)
    

Обработка ответа

HTTP-статус: 200

{
    "result": [
        {
            "ID": "8373",
            "PARENT_ID": "8373",
            "ACTIVE": "Y",
            "DELETED": "N",
            "CAL_TYPE": "user",
            "OWNER_ID": "1269",
            "NAME": "Планерка отдела продаж",
            "DATE_FROM": "11/20/2026 10:00:00 am",
            "DATE_TO": "11/20/2026 11:00:00 am",
            "ORIGINAL_DATE_FROM": null,
            "DATE_FROM_TS_UTC": "1795147200",
            "DATE_TO_TS_UTC": "1795150800",
            "DT_SKIP_TIME": "N",
            "DT_LENGTH": 3600,
            "EVENT_TYPE": null,
            "CREATED_BY": "1269",
            "DATE_CREATE": "10/27/2026 07:14:36 pm",
            "TIMESTAMP_X": "10/27/2026 07:14:36 pm",
            "DESCRIPTION": "Обсуждаем план на неделю",
            "DT_FROM": null,
            "DT_TO": null,
            "PRIVATE_EVENT": "",
            "ACCESSIBILITY": "busy",
            "IMPORTANCE": "normal",
            "IS_MEETING": true,
            "MEETING_STATUS": "H",
            "MEETING_HOST": "1269",
            "MEETING": {
                "HOST_NAME": "Иван Иванов",
                "NOTIFY": true,
                "REINVITE": false,
                "ALLOW_INVITE": false,
                "HIDE_GUESTS": false,
                "MEETING_CREATOR": 1269,
                "LANGUAGE_ID": "ru",
                "MAIL_FROM": ""
            },
            "LOCATION": "Переговорная 1",
            "REMIND": [
                {
                    "type": "min",
                    "count": 15
                }
            ],
            "COLOR": "#9cbe1c",
            "TEXT_COLOR": "",
            "RRULE": "",
            "EXDATE": "",
            "DAV_XML_ID": "20261120T070000Z-1de13363db84ad6757cacd3954782b9f@your-domain.bitrix24.ru",
            "G_EVENT_ID": "",
            "DAV_EXCH_LABEL": "",
            "CAL_DAV_LABEL": "",
            "VERSION": "1",
            "ATTENDEES_CODES": [
                "U1269",
                "U1271"
            ],
            "RECURRENCE_ID": null,
            "RELATIONS": "",
            "SECTION_ID": "157",
            "SYNC_STATUS": null,
            "UF_CRM_CAL_EVENT": null,
            "UF_WEBDAV_CAL_EVENT": null,
            "SECTION_DAV_XML_ID": null,
            "DATE_FROM_FORMATTED": "Fri Nov 20 2026 10:00:00",
            "DATE_TO_FORMATTED": "Fri Nov 20 2026 11:00:00",
            "IS_DAYLIGHT_SAVING_TZ": "N",
            "SECT_ID": "157",
            "OPTIONS": null,
            "ATTENDEE_LIST": [
                {
                    "id": 1269,
                    "entryId": "8373",
                    "status": "H"
                },
                {
                    "id": 1271,
                    "entryId": "8375",
                    "status": "Q"
                }
            ],
            "COLLAB_ID": null,
            "attendeesEntityList": [
                {
                    "entityId": "user",
                    "id": 1269
                },
                {
                    "entityId": "user",
                    "id": 1271
                }
            ],
            "~DESCRIPTION": "Обсуждаем план на неделю",
            "~USER_OFFSET_FROM": 0,
            "~USER_OFFSET_TO": 0,
            "DT_FROM_TS": 1795158000,
            "DT_TO_TS": 1795161600,
            "~URL": "https://your-domain.bitrix24.ru/company/personal/user/1269/calendar/?EVENT_ID=8373&EVENT_DATE=11%2F20%2F2026",
            "~WEEK_DAY": "Пт",
            "~FROM_TO_HTML": "11/20/2026,  10:00 am -  11:00 am",
            "~detailUrl": "/company/personal/user/1269/calendar/?EVENT_ID=8373&EVENT_DATE=11%2F20%2F2026%2010%3A00%3A00%20am",
            "TIMESTAMP_X_ISO": "2026-10-27T19:14:36+03:00",
            "DATE_CREATE_ISO": "2026-10-27T19:14:36+03:00"
        }
    ],
    "time": {
        "start": 1793117687,
        "finish": 1793117687.886115,
        "duration": 0.8861150741577148,
        "processing": 0,
        "date_start": "2026-10-27T19:14:47+03:00",
        "date_finish": "2026-10-27T19:14:47+03:00",
        "operating_reset_at": 1793118240,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
array

Массив будущих событий календаря (подробное описание). Если в периоде выборки событий нет, массив пустой

time
time

Информация о времени выполнения запроса

Объект события

Название
тип

Описание

ID
string

Идентификатор события

PARENT_ID
string

Идентификатор родительского события

ACTIVE
string

Признак активности события. Возможные значения:

  • Y — событие активно
  • N — событие неактивно

Метод calendar.event.getbyid поле не возвращает

DELETED
string

Флаг отображающий удалено ли событие. Возможные значения:

  • Y — событие удалено
  • N — событие не удалено

Значение Y приходит только в ответе calendar.event.get с параметром modified_since

CAL_TYPE
string

Тип календаря в котором находится событие

OWNER_ID
string

Идентификатор владельца календаря:

  • id пользователя для типа календаря user
  • id группы для типа календаря group

NAME
string

Название события

DATE_FROM
datetime

Дата начала события

DATE_TO
datetime

Дата окончания события

ORIGINAL_DATE_FROM
datetime

Дата начала оригинального события для повторяемых событий

TZ_FROM
string

Таймзона даты начала события.

Метод calendar.event.get.nearest поле не возвращает

TZ_TO
string

Таймзона даты окончания события.

Метод calendar.event.get.nearest поле не возвращает

TZ_OFFSET_FROM
string

Смещение времени начала события относительно UTC в секундах.

Метод calendar.event.get.nearest поле не возвращает

TZ_OFFSET_TO
string

Смещение времени окончания события относительно UTC в секундах.

Метод calendar.event.get.nearest поле не возвращает

DATE_FROM_TS_UTC
string

Дата и время начала события в формате timestamp.

Несмотря на название, значение сдвинуто на смещение часового пояса сервера, поэтому читать его как время UTC нельзя. Точное время начала задают поля DATE_FROM и TZ_FROM

DATE_TO_TS_UTC
string

Дата и время окончания события в формате timestamp.

Несмотря на название, значение сдвинуто на смещение часового пояса сервера, поэтому читать его как время UTC нельзя. Точное время окончания задают поля DATE_TO и TZ_TO

DT_SKIP_TIME
string

Флаг отображающий что событие длится целый день. Возможные значения:

  • Y — целый день
  • N — не целый день

DT_LENGTH
integer

Длительность события в секундах

EVENT_TYPE
string

Тип события

CREATED_BY
string

Идентификатор пользователя, который создал событие

DATE_CREATE
datetime

Дата создания события

TIMESTAMP_X
datetime

Дата изменения события

DATE_CREATE_ISO
string

Дата создания события в формате ISO 8601 со смещением часового пояса портала, например 2026-10-08T10:27:29+03:00.

Поле не возвращается, если дата создания не заполнена

TIMESTAMP_X_ISO
string

Дата изменения события в формате ISO 8601 со смещением часового пояса портала.

Значение можно передать в параметр modified_since метода calendar.event.get, чтобы получить события, измененные с этого момента. У всех экземпляров повторяющегося события значение одинаковое. Поле не возвращается, если дата изменения не заполнена

DESCRIPTION
string

Описание события

DT_FROM
string

Служебное поле. Приходит со значением null

Метод calendar.event.getbyid поле не возвращает

DT_TO
string

Служебное поле. Приходит со значением null

Метод calendar.event.getbyid поле не возвращает

PRIVATE_EVENT
string

Отметка, что событие частное. Возможные значения:

  • Y — частное
  • N или пустая строка — не частное

ACCESSIBILITY
string

Занятость участников во время события. Возможные значения:

  • busy — занят
  • absent — отсутствую
  • quest — под вопросом
  • free — свободен

IMPORTANCE
string

Важность события. Возможные значения:

  • high — высокая
  • normal — средняя
  • low — низкая

IS_MEETING
boolean

Признак встречи с участниками события. Возможные значения:

  • true — встреча с участниками
  • false — событие без участников

MEETING_STATUS
string

Статус участия в событии. Возможные значения:

  • Y — согласен
  • N — отказался
  • Q — приглашен, но еще не ответил
  • H — организатор события

MEETING_HOST
string

Идентификатор пользователя, ведущего событие

MEETING
object

Настройки встречи (подробное описание)

LOCATION
string

Идентификатор или название места проведения события

REMIND
array

Массив объектов с описанием напоминаний о событии (подробное описание)

COLOR
string

Цвет фона события

TEXT_COLOR
string

Цвет текста события. Если цвет не задан — пустая строка

Метод calendar.event.getbyid поле не возвращает

RRULE
object

Повторяемость события в виде объекта в терминах стандарта iCalendar (подробное описание). Для неповторяемого события — пустая строка

EXDATE
string

Список дат исключений из правила повторений

DAV_XML_ID
string

Идентификатор синхронизации

G_EVENT_ID
string

Идентификатор синхронизации

DAV_EXCH_LABEL
string

Идентификатор синхронизации с Exchange

CAL_DAV_LABEL
string

Идентификатор синхронизации

VERSION
string

Версия изменений события

ATTENDEES_CODES
array

Идентификаторы участников события

RECURRENCE_ID
string

Идентификатор оригинального события при редактировании только текущего

RELATIONS
object

Объект для повторяемых событий с информацией о связях с оригинальным событием (подробное описание). Для неповторяемого события — пустая строка

SECTION_ID
string

Идентификатор календаря в котором расположено событие

SYNC_STATUS
string

Статус синхронизации события

UF_CRM_CAL_EVENT
array

Массив идентификаторов объектов CRM, привязанных к событию, например CO_1 или L_5. Если привязок нет — null

UF_WEBDAV_CAL_EVENT
array

Массив идентификаторов файлов привязанных к событию

SECTION_DAV_XML_ID
array

Идентификатор синхронизации календаря события

DATE_FROM_FORMATTED
string

Форматированная дата начала события

DATE_TO_FORMATTED
string

Форматированная дата окончания события

IS_DAYLIGHT_SAVING_TZ
string

Признак перехода на летнее время в часовом поясе TZ_FROM. Возможные значения:

  • Y — в часовом поясе есть переход на летнее время
  • N — перехода нет

SECT_ID
string

Идентификатор календаря в котором расположено событие

OPTIONS
object

Дополнительные параметры события с категорией, например идентификатор категории CATEGORY_ID и количество участников ATTENDEES_COUNT. Для обычного события — null

ATTENDEE_LIST
array

Массив объектов, описывающих участников события и их статусы участия (подробное описание)

COLLAB_ID
integer

Идентификатор коллабы, в которой создано событие

~RRULE_DESCRIPTION
string

Текстовое описание правила повторения события

attendeesEntityList
array

Массив объектов, описывающих пользователей — участников события (подробное описание)

~DESCRIPTION
string

Описание события

~USER_OFFSET_FROM
integer

Смещение времени начала события относительно часового пояса текущего пользователя

~USER_OFFSET_TO
integer

Смещение времени окончания события относительно часового пояса текущего пользователя

DT_FROM_TS
integer

Дата и время начала события в формате timestamp с учетом часового пояса текущего пользователя.

Поле возвращает только метод calendar.event.get.nearest

DT_TO_TS
integer

Дата и время окончания события в формате timestamp с учетом часового пояса текущего пользователя.

Поле возвращает только метод calendar.event.get.nearest

~URL
string

Ссылка на событие в календаре.

Поле возвращает только метод calendar.event.get.nearest

~WEEK_DAY
string

Сокращенное название дня недели, на который приходится начало события.

Поле возвращает только метод calendar.event.get.nearest

~detailUrl
string

Ссылка на событие, собранная по шаблону из параметра detailUrl.

Поле возвращает только метод calendar.event.get.nearest, если передан параметр detailUrl

~FROM_TO_HTML
string

Дата и время события в виде строки для отображения, например 11/20/2026, 10:00 am - 11:00 am.

Поле возвращает только метод calendar.event.get.nearest

Объект MEETING

Название
тип

Описание

HOST_NAME
string

имя пользователя ведущего событие

NOTIFY
boolean

Флаг оповещения о подтверждении или отказе участников

REINVITE
boolean

Флаг запроса повторного подтверждения участия при редактировании события

ALLOW_INVITE
boolean

Флаг разрешения участникам приглашать других в событие

HIDE_GUESTS
boolean

Флаг скрытия списка участников

MEETING_CREATOR
integer

Идентификатор создателя события

LANGUAGE_ID
string

Идентификатор языка для уведомлений по событию

MAIL_FROM
string

Адрес отправителя для уведомлений

Объект REMIND

Название
тип

Описание

type
string

Временной тип напоминания

  • min — минуты
  • hour – часы
  • day — дни

count
integer

Числовое значение временного промежутка

Объект RRULE

Название
тип

Описание

FREQ
string

Частота повторения

  • DAILY — ежедневно
  • WEEKLY — еженедельно
  • MONTHLY — ежемесячно
  • YEARLY — ежегодно

BYDAY
object

Дни недели

  • SU — воскресенье
  • MO — понедельник
  • TU — вторник
  • WE — среда
  • TH — четверг
  • FR — пятница
  • SA — суббота

INTERVAL
integer

Интервал между повторениями

UNTIL
date

Дата окончания повторений

~UNTIL
date

Дата окончания повторений. Техническое поле

UNTIL_TS
integer

Дата окончания повторений в формате timestamp

Объект RELATIONS

Название
тип

Описание

ORIGINAL_RECURSION_ID
integer

Идентификатор оригинального события для повторяемых созданных при редактировании

COMMENT_XML_ID
string

Идентификатор оригинального события для одиночных, созданных при редактировании из повторяемых

Объекты ATTENDEE_LIST

Название
тип

Описание

id
integer

Идентификатор пользователя

entryId
string

Идентификатор события

status
string

Статус участника события. Возможные значения:

  • Y — согласен
  • N — отказался
  • Q — приглашен, но еще не ответил
  • H — организатор события

Объект attendeesEntityList

Название
тип

Описание

entityId
string

Тип объекта участника события

id
integer

Идентификатор участника события

Обработка ошибок

HTTP-статус: 400

{
  "error": "",
  "error_description": "Доступ запрещен"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

Пустое значение

Доступ запрещен

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

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение