Get the list of bookings booking.v1.booking.list
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
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'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",
}
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('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",
}
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.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",
}
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', 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>';
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 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 |
|
|
|
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: 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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". 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
- Delete Booking booking.v1.booking.delete
- Add Booking booking.v1.booking.add
- Update Booking booking.v1.booking.update
- Get Information About Booking booking.v1.booking.get