Online Booking: 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.
Online booking is a tool for automating the reservation of resources: rooms, equipment, specialist services, and more. You can move clients between the waitlist and bookings, manage occupancy, and synchronize resources with external systems.
Quick navigation: all methods
User documentation: Booking: Getting Started
Online booking has three groups of methods: resources, waitlist, and booking. The methods are interconnected:
- resources define what can be booked
- the waitlist handles overload
- booking methods record occupancy
In the on-premise Bitrix24, methods can be used starting from the module version booking 25.300.0.
Setting Up Resources
Resources are objects that can be booked: rooms, equipment, services. Methods in this group allow you to:
- create, modify, and delete resources — booking.v1.resource.*
- configure resource types, such as "room," "car," "specialist" — booking.v1.resourceType.*
- set resource availability by time — booking.v1.resource.slots.*
Working with the Waitlist
Use the waitlist when the desired resource is temporarily unavailable. Methods in this group allow you to:
- add, modify, and delete entries in the waitlist — booking.v1.waitlist.*
- move an entry from booking to the waitlist — booking.v1.waitlist.createfrombooking
- manage relationships between waitlist entries and CRM clients — booking.v1.waitlist.client.* and other objects — booking.v1.waitList.externalData.*
Booking Resources
Booking is a confirmed reservation for a resource. Methods in this group allow you to:
- create, modify, and cancel bookings — booking.v1.booking.*
- create a booking from an entry in the waitlist — booking.v1.booking.createfromwaitlist
- manage relationships between bookings and CRM clients — booking.v1.booking.client.* and other objects — booking.v1.booking.externalData.*
Overview of Methods
Scope:
bookingWho can execute the method: any user
Resource
|
Method |
Description |
|
Adds a new resource |
|
|
Deletes a resource |
|
|
Retrieves a resource |
|
|
Retrieves a list of resources |
|
|
Updates a resource |
Resource Type
|
Method |
Description |
|
Adds a new resource type |
|
|
Deletes a resource type |
|
|
Retrieves a resource type |
|
|
Retrieves a list of resource types |
|
|
Updates a resource type |
Time Slots for Resources
|
Method |
Description |
|
Retrieves the slot settings for a resource |
|
|
Sets slots for a resource |
|
|
Removes slots for a resource |
Waitlist
|
Method |
Description |
|
Adds to the waitlist |
|
|
Creates an entry in the waitlist from a booking |
|
|
Deletes an entry from the waitlist |
|
|
Retrieves an entry from the waitlist |
|
|
Retrieves a list of entries from the waitlist |
|
|
Updates an entry in the waitlist |
Client in the Waitlist
|
Method |
Description |
|
Retrieves a list of clients in the waitlist entry |
|
|
Adds clients to the waitlist entry |
|
|
Removes clients from the waitlist entry |
Waitlist Relationships with Additional Objects
|
Method |
Description |
|
Retrieves relationships for the waitlist entry |
|
|
Sets relationships for the waitlist entry |
|
|
Removes relationships for the waitlist entry |
Booking
|
Method |
Description |
|
Adds a booking |
|
|
Creates a booking from the waitlist |
|
|
Deletes a booking |
|
|
Retrieves booking information |
|
|
Retrieves a list of bookings |
|
|
Updates a booking |
Client in Booking
|
Method |
Description |
|
Retrieves a list of clients in the booking |
|
|
Adds a client to the booking |
|
|
Removes clients from the booking |
Booking Relationships with Additional Objects
|
Method |
Description |
|
Retrieves relationships for the booking |
|
|
Sets relationships for the booking |
|
|
Removes relationships for the booking |
Auxiliary Methods
|
Method |
Description |
|
Retrieves a list of client types |