Get calendar settings structure

Gets the structure of the default calendar settings

Parameters

Function GetCalendarSettingsStructure(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.settings.get

1C:Enterprise/OneScript code example

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

    Result = OPI_Bitrix24.GetCalendarSettingsStructure(URL);

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

    Result = OPI_Bitrix24.GetCalendarSettingsStructure(URL, Token);

Bash

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

CMD/Bat

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

Result

{
 "result": {
  "work_time_start": "9",
  "work_time_end": "19",
  "year_holidays": "1.01,2.01,7.01,23.02,8.03,1.05,9.05,12.06,4.11",
  "year_workdays": "31.12",
  "week_holidays": [
   "SA",
   "SU"
  ],
  "week_start": "MO",
  "user_name_template": "#NAME# #LAST_NAME#",
  "sync_by_push": "",
  "user_show_login": "1",
  "path_to_user": "/company/personal/user/#user_id#/",
  "path_to_user_calendar": "/company/personal/user/#user_id#/calendar/",
  "path_to_group": "/workgroups/group/#group_id#/",
  "path_to_group_calendar": "/workgroups/group/#group_id#/calendar/",
  "path_to_vr": "",
  "path_to_rm": "",
  "rm_iblock_type": "",
  "rm_iblock_id": "",
  "dep_manager_sub": "1",
  "denied_superpose_types": [],
  "pathes_for_sites": "",
  "pathes": [],
  "forum_id": "1",
  "rm_for_sites": "1",
  "path_to_type_company_calendar": "/calendar/",
  "path_to_type_events": "",
  "path_to_type_location": ""
 },
 "time": {
  "start": 1779805004,
  "finish": 1779805004.28804,
  "duration": 0.288036108016968,
  "processing": 0,
  "date_start": "2026-05-26T14:16:44+00:00",
  "date_finish": "2026-05-26T14:16:44+00:00",
  "operating_reset_at": 1779805604,
  "operating": 0
 }
}