Get Information About Booking booking.v1.booking.get
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.
Scope:
bookingWho can execute the method: any user
The method booking.v1.booking.get returns information about a booking by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Booking identifier |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.booking.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.booking.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 BookingGetResult = {
booking: {
datePeriod: {
from: { timestamp: number; timezone: string }
to: { timestamp: number; timezone: string }
}
description: string | null
id: number
name: string
resourceIds: number[]
}
}
try {
const response = await $b24.actions.v2.call.make<BookingGetResult>({
method: 'booking.v1.booking.get',
params: {
id: 15,
},
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.booking.id, result.booking.name, result.booking.resourceIds)
}
} 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 getBooking() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.booking.get',
params: {
id: 15,
},
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.booking.id, result.booking.name, result.booking.resourceIds)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getBooking)
</script>
try {
$response = $b24Service
->core
->call(
'booking.v1.booking.get',
[
'id' => 15,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting booking: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.booking.get",
{
id: 15
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'booking.v1.booking.get',
[
'id' => 15
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"booking": {
"datePeriod": {
"from": {
"timestamp": 1723446900,
"timezone": "Europe/Berlin"
},
"to": {
"timestamp": 1723447800,
"timezone": "Europe/Berlin"
}
},
"description": null,
"id": 15,
"name": "booking 1",
"resourceIds": [
1,
2
]
}
},
"time": {
"start": 1741002780.099604,
"finish": 1741002780.381558,
"duration": 0.2819540500640869,
"processing": 0.14896297454833984,
"date_start": "2025-03-03T11:53:00+00:00",
"date_finish": "2025-03-03T11:53:00+00:00",
"operating": 0.14890098571777344
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains information about the booking fields. The structure is described below |
|
time |
Information about the request execution time |
Booking
|
datePeriod |
Time period of the booking. Contains |
|
description |
Description of the booking. Can be |
|
id |
Booking identifier |
|
name |
Name of the booking |
|
resourceIds |
Array of resource identifiers associated with the booking. Resource descriptions can be obtained using the method booking.v1.resource.get |
Error Handling
HTTP status: 400
{
"error": 1021,
"error_description": "Booking not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
Booking with such |
|
|
|
Required parameter not provided |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Create a Booking from the Waitlist booking.v1.booking.createfromwaitlist
- Update Booking booking.v1.booking.update
- Add Booking booking.v1.booking.add
- Get the list of bookings booking.v1.booking.list
- Delete Booking booking.v1.booking.delete