Get main calendar settings calendar.settings.get

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

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 -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>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.calendar.settings.get().response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "calendar.settings.get", nil, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("calendar.settings.get: %w", err)
        }
        
        var item struct {
        	WorkTimeStart    string `json:"work_time_start"`
        	WorkTimeEnd      string `json:"work_time_end"`
        	YearHolidays     string `json:"year_holidays"`
        	YearWorkdays     string `json:"year_workdays"`
        	WeekStart        string `json:"week_start"`
        	UserNameTemplate string `json:"user_name_template"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.WorkTimeStart, item.WorkTimeEnd)
        

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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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