Get the list of bookings booking.v1.booking.list
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.list returns a list of bookings based on the filter. It is an implementation of the listing method for bookings.
Method Parameters
|
FILTER |
Object for filtering the list of bookings, description of available fields below |
|
ORDER |
Object for sorting the list of bookings. The sorting direction can take the following values:
The default value is |
Filter Parameters
|
Name |
Description |
|
within |
Object for filtering by booking time in the format
If the object is provided, all parameters within it are required |
|
client |
Object for filtering by client, accepts an array of
Available types and module for clients are returned by the method booking.v1.clienttype.list. If the object is provided, all parameters within it are required |
Order Parameters
|
Name |
Description |
|
id |
Sort by identifier |
|
dateFrom |
Sort by start date |
|
dateTo |
Sort by end date |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"within":{"dateFrom":0,"dateTo":1739262600},"client":{"entities":[{"code":"CONTACT","module":"crm","id":"1"},{"code":"COMPANY","module":"crm","id":"1"}]}},"order":{"id":"ASC","dateFrom":"DESC","dateTo":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.booking.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"within":{"dateFrom":0,"dateTo":1739262600},"client":{"entities":[{"code":"CONTACT","module":"crm","id":"1"},{"code":"COMPANY","module":"crm","id":"1"}]}},"order":{"id":"ASC","dateFrom":"DESC","dateTo":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.booking.list
// 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 BookingListResult = {
booking: {
datePeriod: {
from: { timestamp: number; timezone: string }
to: { timestamp: number; timezone: string }
}
description: string | null
id: number
name: string
resourceIds: number[]
}[]
}
try {
// booking.v1.booking.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<BookingListResult>({
method: 'booking.v1.booking.list',
params: {
filter: {
within: {
dateFrom: 0,
dateTo: 1739262600,
},
client: {
entities: [
{
code: 'CONTACT',
module: 'crm',
id: '1',
},
{
code: 'COMPANY',
module: 'crm',
id: '1',
},
],
},
},
order: {
id: 'ASC',
dateFrom: 'DESC',
dateTo: 'ASC',
},
start: 0,
},
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.length, result.booking)
}
} 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 fetchBookingList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// booking.v1.booking.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.booking.list',
params: {
filter: {
within: {
dateFrom: 0,
dateTo: 1739262600,
},
client: {
entities: [
{
code: 'CONTACT',
module: 'crm',
id: '1',
},
{
code: 'COMPANY',
module: 'crm',
id: '1',
},
],
},
},
order: {
id: 'ASC',
dateFrom: 'DESC',
dateTo: 'ASC',
},
start: 0,
},
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.length, result.booking)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchBookingList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.booking.v1.booking.list(filter={
"resourceId": 1,
"within": {
"dateFrom": 0,
"dateTo": 1739262600,
},
"client": {
"entities": [
{
"code": "CONTACT",
"module": "crm",
"id": "1",
},
{
"code": "COMPANY",
"module": "crm",
"id": "1",
},
],
},
}, order={
"id": "desc",
"dateFrom": "DESC",
"dateTo": "ASC",
}).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
)
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(
'booking.v1.booking.list',
[
'filter' => [
'within' => [
'dateFrom' => 0,
'dateTo' => 1739262600,
],
'client' => [
'entities' => [
[
'code' => 'CONTACT',
'module' => 'crm',
'id' => '1',
],
[
'code' => 'COMPANY',
'module' => 'crm',
'id' => '1',
],
],
],
],
'order' => [
'id' => 'ASC',
'dateFrom' => 'DESC',
'dateTo' => 'ASC',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your required data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching booking list: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.booking.list",
{
filter: {
within: {
dateFrom: 0,
dateTo: 1739262600,
},
client: {
entities: [
{
"code": "CONTACT",
"module": "crm",
"id": "1"
},
{
"code": "COMPANY",
"module": "crm",
"id": "1"
}
]
}
},
order: {
id: "ASC",
dateFrom: "DESC",
dateTo: "ASC",
}
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'booking.v1.booking.list',
[
'filter' => [
'within' => [
'dateFrom' => 0,
'dateTo' => 1739262600,
],
'client' => [
'entities' => [
[
'code' => 'CONTACT',
'module' => 'crm',
'id' => '1'
},
[
'code' => 'COMPANY',
'module' => 'crm',
'id' => '1'
]
]
]
],
'order' => [
'id' => 'ASC',
'dateFrom' => 'DESC',
'dateTo' => 'ASC',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "booking.v1.booking.list", b24.Params{
"FILTER": b24.Params{
"within": b24.Params{
"dateFrom": 0,
"dateTo": 1739262600,
},
"client": b24.Params{
"entities": []b24.Params{
{
"code": "CONTACT",
"module": "crm",
"id": "1",
},
{
"code": "COMPANY",
"module": "crm",
"id": "1",
},
},
},
},
"ORDER": b24.Params{
"id": "ASC",
"dateFrom": "DESC",
"dateTo": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("booking.v1.booking.list: %w", err)
}
// The method wraps the response in an object with the "booking" key.
raw, ok := b24.Unwrap(res.Result, "booking")
if !ok {
return fmt.Errorf("no booking key in the response")
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
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 15",
"resourceIds": [
1,
2
]
}
]
},
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains an array of objects with information about bookings. The structure is described below |
|
time |
Information about the time taken to execute the request |
Booking
|
datePeriod |
Period of time for the booking. Contains fields |
|
description |
Description of the booking. Can be |
|
id |
Identifier of the booking |
|
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": 422,
"error_description": "Invalid date period"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
Empty array of resources or such resources do not exist |
|
|
|
Required parameter not provided within |
|
|
|
Required parameter not provided |
|
|
|
Incorrect time period |
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 |
|
|
|
The REST API is available only on commercial plans. 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 |