Get main calendar settings calendar.settings.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
calendarWho can execute the method: any user
This method retrieves the main calendar settings. Only an administrator of the account can modify the main settings.
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.settings.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.settings.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CalendarSettingsResult = {
work_time_start: string
work_time_end: string
year_holidays: string
year_workdays: string
week_holidays: string[]
week_start: string
user_name_template: string
sync_by_push: boolean
user_show_login: boolean
path_to_user: string
path_to_user_calendar: string
path_to_group: string
path_to_group_calendar: string
path_to_vr: string
path_to_rm: string
rm_iblock_type: string
rm_iblock_id: string
dep_manager_sub: boolean
denied_superpose_types: string[]
pathes_for_sites: string
forum_id: string
rm_for_sites: boolean
path_to_type_company_calendar: string
path_to_type_location: string
path_to_type_open_event: string
}
try {
const response = await $b24.actions.v2.call.make<CalendarSettingsResult>({
method: 'calendar.settings.get',
params: {},
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('Calendar settings:', result.work_time_start, result.work_time_end)
}
} 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 getCalendarSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.settings.get',
params: {},
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('Calendar settings:', result.work_time_start, result.work_time_end)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCalendarSettings)
</script>
try {
$response = $b24Service
->core
->call(
'calendar.settings.get',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting calendar settings: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.settings.get',
{}
);
require_once('crest.php');
$result = CRest::call(
'calendar.settings.get',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"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": false,
"user_show_login": true,
"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": true,
"denied_superpose_types": [],
"pathes_for_sites": "",
"forum_id": "8",
"rm_for_sites": true,
"path_to_type_company_calendar": "",
"path_to_type_location": "",
"path_to_type_open_event": ""
},
"time": {
"start": 1733924639.802569,
"finish": 1733924640.184363,
"duration": 0.3817939758300781,
"processing": 0.012382984161376953,
"date_start": "2024-12-11T13:43:59+00:00",
"date_finish": "2024-12-11T13:44:00+00:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
work_time_start |
Start time of the workday |
|
work_time_end |
End time of the workday |
|
year_holidays |
List of holidays |
|
week_holidays |
Array of weekend days |
|
week_start |
Day the week starts |
|
user_name_template |
User name template |
|
sync_by_push |
Flag for automatic calendar synchronization via subscription. Push events from Google/Office365 |
|
user_show_login |
Flag for displaying user login |
|
path_to_user |
Template link to user profile |
|
path_to_user_calendar |
Template link to view user calendar |
|
path_to_group |
Template link to view workgroup |
|
path_to_group_calendar |
Template link to view group calendar |
|
path_to_vr |
Template link to video conference room |
|
path_to_rm |
Template link to meeting room |
|
rm_iblock_type |
Type of infoblock for booking meeting and video conference rooms |
|
rm_iblock_id |
Identifier of the infoblock for booking meeting rooms |
|
dep_manager_sub |
Flag allowing managers to view subordinates' calendars |
|
denied_superpose_types |
List of calendar types that cannot be added to favorites |
|
pathes_for_sites |
Sets link templates common for all sites |
|
forum_id |
Identifier of the forum for comments |
|
rm_for_sites |
Sets meeting room parameters common for all sites |
|
path_to_type_company_calendar |
Template link to view company calendars |
|
path_to_type_location |
Template link to view meeting room bookings |
|
path_to_type_open_event |
Template link to view open event calendar |
Error Handling
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Calendar: Overview of Methods
- Get User Calendar Settings calendar.user.settings.get
- Set User Calendar Settings calendar.user.settings.set