Get User Calendar Settings calendar.user.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:
calendarWho can execute the method: any user
This method retrieves user calendar 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.user.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.user.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 CalendarUserSettingsResult = {
view: string
meetSection: string
crmSection: string
showDeclined: boolean
denyBusyInvitation: boolean
collapseOffHours: string
showWeekNumbers: string
showTasks: string
syncTasks: string
showCompletedTasks: string
lastUsedSection: string
sendFromEmail: string
defaultSections: Record<string, string>
syncPeriodPast: string
syncPeriodFuture: string
defaultReminders: {
fullDay: Array<{ type: string; count: number }>
withTime: Array<{ type: string; count: number }>
}
timezoneName: string
timezoneOffsetUTC: number
timezoneDefaultName: string
work_time_start: string
work_time_end: string
}
try {
const response = await $b24.actions.v2.call.make<CalendarUserSettingsResult>({
method: 'calendar.user.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(result.view, result.timezoneName, result.defaultReminders)
}
} 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 getCalendarUserSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.user.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(result.view, result.timezoneName, result.defaultReminders)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCalendarUserSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.user.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.user.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 user calendar settings: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.user.settings.get',
{}
);
require_once('crest.php');
$result = CRest::call(
'calendar.user.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.user.settings.get", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("calendar.user.settings.get: %w", err)
}
var item struct {
View string `json:"view"`
MeetSection string `json:"meetSection"`
CrmSection string `json:"crmSection"`
ShowDeclined bool `json:"showDeclined"`
DenyBusyInvitation bool `json:"denyBusyInvitation"`
CollapseOffHours string `json:"collapseOffHours"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.View, item.MeetSection)
Response Handling
HTTP status: 200
{
"result": {
"view": "month",
"meetSection": "4",
"crmSection": "4",
"showDeclined": true,
"denyBusyInvitation": false,
"collapseOffHours": "N",
"showWeekNumbers": "N",
"showTasks": "Y",
"syncTasks": "N",
"showCompletedTasks": "N",
"lastUsedSection": "false",
"sendFromEmail": "",
"defaultSections": {
"user1": "4",
"group6": "49"
},
"syncPeriodPast": "3",
"syncPeriodFuture": "12",
"defaultReminders": {
"fullDay": [
{
"type": "min",
"count": 15
}
],
"withTime": [
{
"type": "min",
"count": 50
}
]
},
"timezoneName": "Europe/Berlin",
"timezoneOffsetUTC": 7200,
"timezoneDefaultName": "",
"work_time_start": "9.00",
"work_time_end": "19.00"
},
"time": {
"start": 1734434829.455204,
"finish": 1734434829.797482,
"duration": 0.34227800369262695,
"processing": 0.0038161277770996094,
"date_start": "2024-12-17T11:27:09+00:00",
"date_finish": "2024-12-17T11:27:09+00:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
view |
Standard view for the calendar. Possible values:
|
|
meetSection |
Calendar for invitations |
|
crmSection |
Calendar for CRM |
|
showDeclined |
Show events where the user declined to participate |
|
denyBusyInvitation |
Prevent inviting to an event if the time is busy |
|
collapseOffHours |
Hide non-working hours in the calendar in weekly and daily views. Possible values:
|
|
showWeekNumbers |
Show week numbers. Possible values:
|
|
showTasks |
Display tasks in the calendar. Possible values:
|
|
syncTasks |
Synchronize task calendar. Possible values:
|
|
showCompletedTasks |
Display completed tasks. Possible values:
|
|
lastUsedSection |
Identifier of the calendar used when creating events if the calendar identifier is not provided in the parameters. Default value — |
|
sendFromEmail |
E-mail for sending mail invitations |
|
defaultSections |
Settings for preset calendars. The key of the settings object can be:
The value of the object is the calendar identifier |
|
syncPeriodPast |
Number of months for synchronization in the past period |
|
syncPeriodFuture |
Number of months for synchronization in the future period |
|
defaultReminders |
Object with standard settings for event reminders |
|
timezoneName |
Calendar timezone |
|
timezoneOffsetUTC |
Timezone offset relative to UTC in seconds |
|
timezoneDefaultName |
If the |
|
work_time_start |
Start time of the workday |
|
work_time_end |
End time of the workday |
Object defaultReminders
|
Name |
Description |
|
fullDay |
Array of standard reminder settings for all-day events |
|
withTime |
Array of standard reminder settings for events with specified time |
Reminder Settings Object
|
Name |
Description |
|
type |
Time type of the reminder. Possible values:
|
|
count |
Numeric value of the time interval |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |