Получить список календарей calendar.section.get

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

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

Scope: calendar

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

Метод получает список календарей.

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

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

Название
тип

Описание

type*
string

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

  • user — календарь пользователя
  • group — календарь группы
  • company_calendar — календарь компании
  • location — календарь переговорной комнаты. Используется для бронирования времени в календаре переговорной комнаты через стороннее приложение
  • другие типы, в том числе пользовательские

ownerId*
integer

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

Параметр можно не передавать, если тип календаря user. В этом случае используется идентификатор текущего пользователя.

Для типа календаря location параметр ownerId должен иметь значение 0

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.section.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.section.get
// 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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each CalendarSection returned in result[]
type CalendarSection = {
  ID: string
  NAME: string
  GAPI_CALENDAR_ID: string | null
  DESCRIPTION: string
  COLOR: string
  TEXT_COLOR: string
  EXPORT: { ALLOW: boolean }
  CAL_TYPE: string
  OWNER_ID: string
  CREATED_BY: string
  DATE_CREATE: ISODate | null
  TIMESTAMP_X: ISODate | null
  CAL_DAV_CON: string | null
  SYNC_TOKEN: string | null
  PAGE_TOKEN: string | null
  EXTERNAL_TYPE: string
  ACCESS: Record<string, number>
  IS_COLLAB: boolean
  PERM: {
    view_time: boolean
    view_title: boolean
    view_full: boolean
    add: boolean
    edit: boolean
    edit_section: boolean
    access: boolean
  }
}

try {
  // calendar.section.get returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<CalendarSection[]>({
    method: 'calendar.section.get',
    params: {
      type: 'user',
      ownerId: 1,
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Sections count:', result.length, 'first section:', result[0])
  }
} 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 getCalendarSections() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // calendar.section.get returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'calendar.section.get',
        params: {
          type: 'user',
          ownerId: 1,
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Sections count:', result.length, 'first section:', result[0])
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getCalendarSections)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.calendar.section.get(
        type="user",
        owner_id=1,
    ).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.section.get',
            [
                'type'    => 'user',
                'ownerId' => 1
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting calendar section: ' . $e->getMessage();
}
BX24.callMethod(
    'calendar.section.get',
    {
        type: 'user',
        ownerId: 1
    }
);
require_once('crest.php');

$result = CRest::call(
    'calendar.section.get',
    [
        'type' => 'user',
        'ownerId' => 1
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.section.get", b24.Params{
	"type":    "user",
	"ownerId": 1,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("calendar.section.get: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

{
    "result": [
        {
            "ID": "190",
            "NAME": "New Section",
            "GAPI_CALENDAR_ID": null,
            "DESCRIPTION": "Description for section",
            "COLOR": "#9cbeee",
            "TEXT_COLOR": "#283000",
            "EXPORT": {
                "ALLOW": true
            },
            "CAL_TYPE": "user",
            "OWNER_ID": "1",
            "CREATED_BY": "1",
            "DATE_CREATE": "2024-12-10 06:36:00",
            "TIMESTAMP_X": "2024-12-10 06:36:00",
            "CAL_DAV_CON": null,
            "SYNC_TOKEN": null,
            "PAGE_TOKEN": null,
            "EXTERNAL_TYPE": "local",
            "ACCESS": {
                "D114": 17,
                "G2": 13,
                "U2": 15,
                "U1": 19
            },
            "IS_COLLAB": false,
            "PERM": {
                "view_time": true,
                "view_title": true,
                "view_full": true,
                "add": true,
                "edit": true,
                "edit_section": true,
                "access": true
            }
        },
        {
            "ID": "191",
            ...
        }
        {
            "ID": "192",
            ...
        }
    ],
    "time": {
        "start": 1733828946.418185,
        "finish": 1733828946.650208,
        "duration": 0.23202300071716309,
        "processing": 0.0054471492767333984,
        "date_start": "2024-12-08T11:09:06+00:00",
        "date_finish": "2024-12-08T11:09:06+00:00"
    }
}

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

Название
тип

Описание

result
array

Массив календарей

ID
string

Идентификатор календаря

NAME
string

Название календаря

GAPI_CALENDAR_ID
string

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

DESCRIPTION
string

Описание календаря

COLOR
string

Цвет календаря

TEXT_COLOR
string

Цвет текста в календаре

EXPORT
object

Объект с параметрами экспорта календаря

CAL_TYPE
string

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

OWNER_ID
string

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

Для типа Календарь пользователя user поле содержит идентификатор пользователя. Для Календаря группы group — идентификатор группы

CREATED_BY
string

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

DATE_CREATE
datetime

Дата создания календаря

TIMESTAMP_X
datetime

Дата изменения календаря

CAL_DAV_CON
string

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

SYNC_TOKEN
string

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

PAGE_TOKEN
string

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

EXTERNAL_TYPE
string

Тип провайдера для синхронизации

ACCESS
object

Объект данных доступа к календарю.

Ключ объекта — идентификатор прав доступа. Получить название прав доступа можно методом access.name. Определить права доступа для текущего пользователя — методом user.access.

Значение обьекта содержит числовой идентификатор разрешения на право доступа. Индентификаторы разрешения на право доступа отличаются на разных порталах. На текущий момент узнать все идентификаторы может только администратор портала в коробочной версии Битрикс24

IS_COLLAB
boolean

Флаг принадлежности календаря к коллабе

PERM
object

Объект прав доступа текущего пользователя к календарю

Объект EXPORT

Название
тип

Описание

ALLOW
boolean

Экспорт календаря разрешен

Объект PERM

Название
тип

Описание

view_time
boolean

Просмотр времени событий календаря

view_title
boolean

Просмотр названия событий календаря

view_full
boolean

Полный доступ к информации о событии календаря

add
boolean

Добавление событий в календарь

edit
boolean

Редактирование событий в календаре

edit_section
boolean

Редактирование календаря

access
boolean

Полный доступ к календарю

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр \"type\" для метода \"calendar.section.get\""
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Сообщение об ошибке

Описание

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

Не задан обязательный параметр "type" для метода "calendar.section.get"

Не передан обязательный параметр type

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

Не задан обязательный параметр "ownerId" для метода "calendar.section.get"

Не передан обязательный параметр ownerId и параметр type не равен user

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

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

Запрещен доступ к методу для внешних пользователей

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

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

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

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