Get custom calendar settings

Gets the current users custom calendar settings

Parameters

Function GetCustomCalendarSettings(Val URL, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
Token	--token	String	✖	Access token, when app auth method used

Returns

Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: calendar.user.settings.get

1C:Enterprise/OneScript code example

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";

    Result = OPI_Bitrix24.GetCustomCalendarSettings(URL);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "a5b00469006e9f06006b12e400000001000...";

    Result = OPI_Bitrix24.GetCustomCalendarSettings(URL, Token);

Bash

    oint bitrix24 GetCustomCalendarSettings \
      --url "b24-ar17wx.bitrix24.by" \
      --token "***"

CMD/Bat

    oint bitrix24 GetCustomCalendarSettings ^
      --url "b24-ar17wx.bitrix24.by" ^
      --token "***"

Result

{
 "result": {
  "view": "month",
  "CalendarSelCont": false,
  "SPCalendarSelCont": false,
  "meetSection": "14",
  "crmSection": false,
  "showDeclined": true,
  "denyBusyInvitation": false,
  "collapseOffHours": "N",
  "showWeekNumbers": "N",
  "showTasks": "Y",
  "syncTasks": "N",
  "showCompletedTasks": "N",
  "lastUsedSection": false,
  "sendFromEmail": false,
  "defaultSections": [],
  "syncPeriodPast": 3,
  "syncPeriodFuture": 12,
  "defaultReminders": {
   "fullDay": {
    "type": "daybefore",
    "before": 0,
    "time": 480
   },
   "withTime": {
    "type": "min",
    "count": 15
   }
  },
  "timezoneName": "Europe/Minsk",
  "timezoneOffsetUTC": 10800,
  "timezoneDefaultName": ""
 },
 "time": {
  "start": 1779804999,
  "finish": 1779804999.66732,
  "duration": 0.667321920394898,
  "processing": 0,
  "date_start": "2026-05-26T14:16:39+00:00",
  "date_finish": "2026-05-26T14:16:39+00:00",
  "operating_reset_at": 1779805599,
  "operating": 0
 }
}