Get a list of records from the waitlist booking.v1.waitlist.list
Scope:
bookingWho can execute the method: any user
The method booking.v1.waitlist.list returns a list of records from the waitlist based on the filter.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter |
An object for filtering waitlist records. |
Parameter createdWithin
|
from* |
Start date of the filtering period in the format |
|
to* |
End date of the filtering period in the format |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"createdWithin":{"from":"01.04.2025","to":"16.04.2025"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.waitlist.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"createdWithin":{"from":"01.04.2025","to":"16.04.2025"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.waitlist.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.waitlist.list',
{
filter: {
createdWithin: {
from: "01.04.2025",
to: "16.04.2025",
}
}
},
(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.waitlist.list', {
filter: {
createdWithin: {
from: "01.04.2025",
to: "16.04.2025",
}
}
}, '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.waitlist.list', {
filter: {
createdWithin: {
from: "01.04.2025",
to: "16.04.2025",
}
}
}, 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.waitlist.list',
[
'filter' => [
'createdWithin' => [
'from' => '01.04.2025',
'to' => '16.04.2025', //exclusive, records with the latest date of 15.04.2025 will be selected
],
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing waitlist: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.waitlist.list",
{
filter: {
createdWithin: {
from: "01.04.2025",
to: "16.04.2025", //exclusive, records with the latest date of 15.04.2025 will be selected
}
}
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'booking.v1.waitlist.list',
[
'filter' => [
'createdWithin' => [
'from' => '01.04.2025',
'to' => '16.04.2025' //exclusive, records with the latest date of 15.04.2025 will be selected
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"waitList": [
{
"id": 15,
"note": "note"
},
{
"id": 16,
"note": "note"
}
]
},
"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 records in the waitlist. The structure is described below |
|
time |
Information about the execution time of the request |
Record in the waitlist
|
id |
Identifier of the record in the waitlist |
|
note |
Note associated with the record in the waitlist. Can be |
Error Handling
HTTP status: 400
{
"error": 422,
"error_description": "Invalid date"
}
|
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 |
|
|
|
Required parameter not provided within |
|
|
|
Invalid date |
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 waitlist entry from booking using booking.v1.waitlist.createfrombooking
- Update a record in the waitlist booking.v1.waitlist.update
- Get a Record from the Waitlist booking.v1.waitlist.get
- Add to waitlist booking.v1.waitlist.add
- Delete Entry from the Waitlist booking.v1.waitlist.delete