Bitrix24 Calendar API
The Calendar API from Bitrix24 — 21 operation(s) for calendar.
OpenAPI Specification
openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector Calendar API
version: 1.0.0
description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
contact:
name: Bitrix24 Developer Support
url: https://apidocs.bitrix24.com/support.html
license:
name: MIT
url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
x-logo:
url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
description: Your Bitrix24 portal (cloud)
variables:
portal:
default: your-portal
description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
description: On-Premise Bitrix24 installation
variables:
host:
default: your-bitrix24.example.com
description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Calendar
paths:
/calendar.accessibility.get:
post:
summary: Get User Availability from calendar.accessibility.get
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the availability of users from the list.
operationId: calendar_accessibility_get
tags:
- Calendar
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-accessibility-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
users:
type: array
items: {}
description: '| Array of user IDs ||'
from:
type: string
format: date
description: '| Start date of the period for determining availability in the format `YYYY-MM-DD`.'
to:
type: string
format: date
description: '| End date of the period for determining availability in the format `YYYY-MM-DD`.'
required:
- users
- from
- to
application/x-www-form-urlencoded:
schema:
type: object
properties:
users:
type: array
items: {}
description: '| Array of user IDs ||'
from:
type: string
format: date
description: '| Start date of the period for determining availability in the format `YYYY-MM-DD`.'
to:
type: string
format: date
description: '| End date of the period for determining availability in the format `YYYY-MM-DD`.'
required:
- users
- from
- to
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- calendar
/calendar.event.add:
post:
summary: Add Event calendar.event.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new event to the calendar.
operationId: calendar_event_add
tags:
- Calendar
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Identifier of the calendar owner.'
from_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `from` parameter ||'
to_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `to` parameter ||'
section:
type: integer
description: '| Calendar identifier.'
auto_detect_section:
type: string
description: '| Auto-detection mode for the section.'
name:
type: string
description: '| Event name ||'
skip_time:
type: string
description: '| Pass the date value without time in the `from` and `to` parameters. Possible values:'
timezone_from:
type: string
description: '| Timezone of the event start date and time. Default is the current user''s timezone.'
timezone_to:
type: string
description: '| Timezone of the event end date and time. Default value is the current user''s timezone.'
description:
type: string
description: '| Event description ||'
color:
type: string
description: '| Background color of the event.'
text_color:
type: string
description: '| Text color of the event.'
accessibility:
type: string
description: '| Availability during the event time:'
importance:
type: string
description: '| Event importance:'
private_event:
type: string
description: '| Mark indicating that the event is private. Possible values:'
rrule:
type: object
description: '| Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below'
is_meeting:
type: string
description: '| Indicator of a meeting with event participants. Possible values:'
location:
type: string
description: '| Venue ||'
remind:
type: array
items: {}
description: '| Array of objects describing reminders for the event. The structure is described below ||'
attendees:
type: array
items: {}
description: '| List of identifiers of event participants. This field is mandatory if `is_meeting` = `Y` ||'
host:
type: integer
description: '| Identifier of the event organizer. This field is mandatory if `is_meeting` = `Y` ||'
meeting:
type: object
description: '| Object with meeting parameters. The structure is described below ||'
crm_fields:
type: array
items: {}
description: '| Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:'
FREQ:
type: string
description: '| Recurrence frequency'
COUNT:
type: integer
description: '| Number of recurrences ||'
INTERVAL:
type: integer
description: '| Interval between recurrences ||'
UNTIL:
type: string
format: date
description: '| End date of recurrences ||'
count:
type: integer
description: '| Numerical value of the time interval ||'
notify:
type: boolean
description: '| Flag for notification of confirmation or refusal by participants ||'
reinvite:
type: boolean
description: '| Flag for requesting re-confirmation of participation when editing the event ||'
allow_invite:
type: boolean
description: '| Flag for allowing participants to invite others to the event ||'
hide_guests:
type: boolean
description: '| Flag for hiding the list of participants ||'
required:
- type
- ownerId
- section
- name
- attendees
- host
application/x-www-form-urlencoded:
schema:
type: object
properties:
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Identifier of the calendar owner.'
from_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `from` parameter ||'
to_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `to` parameter ||'
section:
type: integer
description: '| Calendar identifier.'
auto_detect_section:
type: string
description: '| Auto-detection mode for the section.'
name:
type: string
description: '| Event name ||'
skip_time:
type: string
description: '| Pass the date value without time in the `from` and `to` parameters. Possible values:'
timezone_from:
type: string
description: '| Timezone of the event start date and time. Default is the current user''s timezone.'
timezone_to:
type: string
description: '| Timezone of the event end date and time. Default value is the current user''s timezone.'
description:
type: string
description: '| Event description ||'
color:
type: string
description: '| Background color of the event.'
text_color:
type: string
description: '| Text color of the event.'
accessibility:
type: string
description: '| Availability during the event time:'
importance:
type: string
description: '| Event importance:'
private_event:
type: string
description: '| Mark indicating that the event is private. Possible values:'
rrule:
type: object
description: '| Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below'
is_meeting:
type: string
description: '| Indicator of a meeting with event participants. Possible values:'
location:
type: string
description: '| Venue ||'
remind:
type: array
items: {}
description: '| Array of objects describing reminders for the event. The structure is described below ||'
attendees:
type: array
items: {}
description: '| List of identifiers of event participants. This field is mandatory if `is_meeting` = `Y` ||'
host:
type: integer
description: '| Identifier of the event organizer. This field is mandatory if `is_meeting` = `Y` ||'
meeting:
type: object
description: '| Object with meeting parameters. The structure is described below ||'
crm_fields:
type: array
items: {}
description: '| Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:'
FREQ:
type: string
description: '| Recurrence frequency'
COUNT:
type: integer
description: '| Number of recurrences ||'
INTERVAL:
type: integer
description: '| Interval between recurrences ||'
UNTIL:
type: string
format: date
description: '| End date of recurrences ||'
count:
type: integer
description: '| Numerical value of the time interval ||'
notify:
type: boolean
description: '| Flag for notification of confirmation or refusal by participants ||'
reinvite:
type: boolean
description: '| Flag for requesting re-confirmation of participation when editing the event ||'
allow_invite:
type: boolean
description: '| Flag for allowing participants to invite others to the event ||'
hide_guests:
type: boolean
description: '| Flag for hiding the list of participants ||'
required:
- type
- ownerId
- section
- name
- attendees
- host
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- calendar
/calendar.event.delete:
post:
summary: Delete Event calendar.event.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an event.
operationId: calendar_event_delete
tags:
- Calendar
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the event.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the event.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- calendar
/calendar.event.get:
post:
summary: Get Calendar Events List calendar.event.get
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of calendar events.
operationId: calendar_event_get
tags:
- Calendar
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Identifier of the calendar owner.'
from:
type: string
format: date
description: '| Start date for the selection.'
to:
type: string
format: date
description: '| End date for the selection.'
section:
type: array
items: {}
description: '| Array of calendar identifiers ||'
required:
- type
- ownerId
application/x-www-form-urlencoded:
schema:
type: object
properties:
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Identifier of the calendar owner.'
from:
type: string
format: date
description: '| Start date for the selection.'
to:
type: string
format: date
description: '| End date for the selection.'
section:
type: array
items: {}
description: '| Array of calendar identifiers ||'
required:
- type
- ownerId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- calendar
/calendar.event.get.nearest:
post:
summary: Get a list of upcoming events calendar.event.get.nearest
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of upcoming events.
operationId: calendar_event_get_nearest
tags:
- Calendar
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-get-nearest.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Identifier of the calendar owner.'
days:
type: integer
description: '| Number of days to retrieve. Default is `60` ||'
forCurrentUser:
type: boolean
description: '| Output the list of events for the current user. Default is `true` ||'
maxEventsCount:
type: integer
description: '| Maximum number of events to display ||'
detailUrl:
type: string
description: '| URL link to the calendar ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Identifier of the calendar owner.'
days:
type: integer
description: '| Number of days to retrieve. Default is `60` ||'
forCurrentUser:
type: boolean
description: '| Output the list of events for the current user. Default is `true` ||'
maxEventsCount:
type: integer
description: '| Maximum number of events to display ||'
detailUrl:
type: string
description: '| URL link to the calendar ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- calendar
/calendar.event.getbyid:
post:
summary: Get Event by ID calendar.event.getbyid
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about a calendar event by its identifier.
operationId: calendar_event_getbyid
tags:
- Calendar
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-get-by-id.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the event.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the event.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- calendar
/calendar.event.update:
post:
summary: Update Event calendar.event.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an existing event.
operationId: calendar_event_update
tags:
- Calendar
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Event identifier.'
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Calendar owner identifier.'
from_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `from` parameter. ||'
to_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `to` parameter. ||'
section:
type: integer
description: '| Calendar identifier. ||'
name:
type: string
description: '| Event name. ||'
skip_time:
type: string
description: '| Pass the date value without time in the `from` and `to` parameters. Possible values:'
timezone_from:
type: string
description: '| Timezone of the start date and time of the event. Default is the current user''s timezone.'
timezone_to:
type: string
description: '| Timezone of the end date and time of the event. Default value is the current user''s timezone.'
description:
type: string
description: '| Event description. ||'
color:
type: string
description: '| Background color of the event.'
text_color:
type: string
description: '| Text color of the event.'
accessibility:
type: string
description: '| Availability during the event time:'
importance:
type: string
description: '| Event importance:'
private_event:
type: string
description: '| Mark indicating that the event is private. Possible values:'
recurrence_mode:
type: string
description: '| Parameter for partial editing of a recurring event. Possible values:'
current_date_from:
type: string
format: date
description: '| Date of the current event for partial editing of a recurring event.'
rrule:
type: object
description: '| Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below. ||'
is_meeting:
type: string
description: '| Indicator of a meeting with event participants. Possible values:'
location:
type: string
description: '| Location. ||'
remind:
type: array
items: {}
description: '| Array of objects describing reminders for the event. The structure is described below. ||'
attendees:
type: array
items: {}
description: '| List of participant identifiers for the event. This field is required if `is_meeting` = `Y`. ||'
host:
type: string
description: '| Identifier of the event organizer. This field is required if `is_meeting` = `Y`. ||'
meeting:
type: object
description: '| Object with meeting parameters. The structure is described below. ||'
crm_fields:
type: array
items: {}
description: '| Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:'
FREQ:
type: string
description: '| Recurrence frequency'
COUNT:
type: integer
description: '| Number of recurrences. ||'
INTERVAL:
type: integer
description: '| Interval between recurrences. ||'
UNTIL:
type: string
format: date
description: '| End date of recurrences. ||'
count:
type: integer
description: '| Numerical value of the time interval. ||'
notify:
type: boolean
description: '| Flag for notification of confirmation or refusal from participants. ||'
reinvite:
type: boolean
description: '| Flag for requesting re-confirmation of participation when editing the event. ||'
allow_invite:
type: boolean
description: '| Flag allowing participants to invite others to the event. ||'
hide_guests:
type: boolean
description: '| Flag for hiding the list of participants. ||'
required:
- id
- type
- ownerId
- name
- attendees
- host
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Event identifier.'
type:
type: string
description: '| Calendar type:'
ownerId:
type: integer
description: '| Calendar owner identifier.'
from_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `from` parameter. ||'
to_ts:
type: integer
description: '| Date and time in timestamp format. Can be used instead of the `to` parameter. ||'
section:
type: integer
description: '| Calendar identifier. ||'
name:
type: string
description: '| Event name. ||'
skip_time:
type: string
description: '| Pass the date value without time in the `from` and `to` parameters. Possible values:'
timezone_from:
type: string
description: '| Timezone of the start date and time of the event. Default is the current user''s timezone.'
timezone_to:
type: string
description: '| Timezone of the end date and time of the event. Default value is the current user''s timezone.'
description:
type: string
description: '| Event description. ||'
color:
type: string
description: '| Background color of the event.'
text_color:
type: string
description: '| Text color of the event.'
accessibility:
type: string
description: '| Availability during the event time:'
importance:
type: string
description: '| Event importance:'
private_event:
type: string
description: '| Mark indicating that the event is private. Possible values:'
recurrence_m
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-calendar-api-openapi.yml