Get main calendar settings calendar.settings.get

Scope: calendar

Who 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'calendar.settings.get',
        		{}
        	);
        	
        	const result = response.getData().result;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

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 `type`	Description
result `object`	Root element of the response
work_time_start `string`	Start time of the workday
work_time_end `string`	End time of the workday
year_holidays `string`	List of holidays
week_holidays `array`	Array of weekend days
week_start `string`	Day the week starts
user_name_template `string`	User name template
sync_by_push `boolean`	Flag for automatic calendar synchronization via subscription. Push events from Google/Office365
user_show_login `boolean`	Flag for displaying user login
path_to_user `string`	Template link to user profile
path_to_user_calendar `string`	Template link to view user calendar
path_to_group `string`	Template link to view workgroup
path_to_group_calendar `string`	Template link to view group calendar
path_to_vr `string`	Template link to video conference room
path_to_rm `string`	Template link to meeting room
rm_iblock_type `string`	Type of infoblock for booking meeting and video conference rooms
rm_iblock_id `string`	Identifier of the infoblock for booking meeting rooms
dep_manager_sub `boolean`	Flag allowing managers to view subordinates' calendars
denied_superpose_types `array`	List of calendar types that cannot be added to favorites
pathes_for_sites `boolean`	Sets link templates common for all sites
forum_id `string`	Identifier of the forum for comments
rm_for_sites `boolean`	Sets meeting room parameters common for all sites
path_to_type_company_calendar `string`	Template link to view company calendars
path_to_type_location `string`	Template link to view meeting room bookings
path_to_type_open_event `string`	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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Delete Calendar

Get User Calendar Settings

Get main calendar settings calendar.settings.get

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning