Calendar: Overview of Methods
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.
The calendar helps users plan meetings, tasks, and events. Calendars can be managed using a group of methods calendar.section.*.
Calendar events are scheduled activities or meetings. A group of methods calendar.event.* is used to create, modify, retrieve, or delete events.
Quick navigation: all methods and events
User documentation: Bitrix24 Calendar
Connection with Other Objects
User. The calendar is linked to a user by the calendar owner's ID ownerId for the calendar type user. The user ID can be obtained using the method user.get.
Group. The calendar is linked to a group by the calendar owner's ID ownerId for the calendar type group. The ID can be obtained by creating a new group or by getting the list of groups.
User documentation
Calendar Settings
In the main calendar settings, the company's working hours, weekends, and holidays are specified. The settings can be retrieved using the method calendar.settings.get.
In user settings, an employee can specify personal preferences, such as a time zone or week number display. User settings can be retrieved using the method calendar.user.settings.get and set using the method calendar.user.settings.set.
User documentation
Resource Booking
In Bitrix24, resource booking is done through a custom CRM field of type resourcebooking. Such a field can be created in the lead and deal forms.
Resource availability can be tracked in the CRM Calendar. Technically, a resource is a section of the calendar, and booking is a calendar event.
Resources are managed by the calendar.resource.* method group.
User documentation
Widgets
An application can be embedded into the calendar. In the list of calendar view types, there is a place for embedding CALENDAR_GRIDVIEW, where you can add your item.
Typical use-cases and scenarios
Overview of Methods and Events
Scope:
calendarWho can execute the method: any user
Main
|
Method |
Description |
|
Adds a new calendar |
|
|
Updates a calendar |
|
|
Retrieves a list of calendars |
|
|
Deletes a calendar |
|
|
Retrieves basic calendar settings |
|
|
Retrieves user calendar settings |
|
|
Sets user calendar settings |
|
Event |
Triggered |
|
When adding a calendar section or resource |
|
|
When changing a calendar section or resource |
|
|
When deleting a calendar section or resource |
Calendar Events
|
Method |
Description |
|
Adds an event |
|
|
Updates an event |
|
|
Retrieves an event by |
|
|
Retrieves a list of calendar events |
|
|
Retrieves a list of future events |
|
|
Deletes an event |
|
|
Retrieves the current user's participation status in an event |
|
|
Sets event participation status for the current user |
|
|
Retrieves the availability of users from a list |
|
Event |
Triggered |
|
When adding an event |
|
|
When changing an event |
|
|
When deleting an event |
Resource Booking
|
Method |
Description |
|
Adds a resource |
|
|
Updates a resource |
|
|
Retrieves a list of resources |
|
|
Retrieves resource bookings by filter |
|
|
Deletes a resource |