Get Slot Settings for Resource booking.v1.resource.slots.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
bookingWho can execute the method: any user
The method booking.v1.resource.slots.list returns the configuration of time slots for the specified resource.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
resourceId* |
Resource identifier. Can be obtained using the methods booking.v1.resource.add and booking.v1.resource.list |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"resourceId":257}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.slots.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"resourceId":257,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.resource.slots.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 SlotsListResult = {
slots: {
id: number
from: number
to: number
timezone: string
weekDays: string[]
slotSize: number
}[]
}
try {
// The method returns all resource slots at once: it has no pagination
const response = await $b24.actions.v2.call.make<SlotsListResult>({
method: 'booking.v1.resource.slots.list',
params: {
resourceId: 257,
},
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('Slots:', result.slots, 'Count:', result.slots.length)
}
} 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 listResourceSlots() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// The method returns all resource slots at once: it has no pagination
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.resource.slots.list',
params: {
resourceId: 257,
},
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('Slots:', result.slots, 'Count:', result.slots.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listResourceSlots)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.booking.v1.resource.slots.list(
resource_id=257,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
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.resource.slots.list',
[
'resourceId' => 257,
]
);
$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 listing resource slots: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.resource.slots.list",
{
resourceId: 257,
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'booking.v1.resource.slots.list',
[
'resourceId' => 257
]
);
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.resource.slots.list", b24.Params{
"resourceId": 257,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("booking.v1.resource.slots.list: %w", err)
}
// The method wraps the response in an object with the "slots" key.
raw, ok := b24.Unwrap(res.Result, "slots")
if !ok {
return fmt.Errorf("no slots key in the response")
}
// Numeric fields with the value 0 arrive as null, hence the pointers
var items []struct {
From *int `json:"from"`
ID b24.ID `json:"id"`
SlotSize *int `json:"slotSize"`
Timezone string `json:"timezone"`
To int `json:"to"`
WeekDays []string `json:"weekDays"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Timezone, it.WeekDays)
}
Response Handling
HTTP status: 200
{
"result": {
"slots": [
{
"from": 540,
"id": 11,
"slotSize": 60,
"timezone": "Europe/Berlin",
"to": 1080,
"weekDays": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
]
}
]
},
"total": 0,
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+01:00",
"date_finish": "2025-01-21T13:47:08+01:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains a single field |
|
total |
Service field. The method always returns |
|
time |
Information about the request execution time |
Slot
If no slots are set for the resource, the method returns an empty array.
Numeric fields with the value 0 are returned as null. This applies to from for a slot starting at the beginning of the day and to slotSize.
|
Name |
Description |
|
id |
Identifier of the slot settings |
|
from |
Time in minutes from the start of the day from which booking is available. Value in the range from 0 to 1440. For example, |
|
to |
Time in minutes from the start of the day until which booking is available. Value in the range from 0 to 1440 and strictly greater than |
|
timezone |
Time zone in the IANA format relative to which the slot time is set. For example, |
|
weekDays |
Array of available weekdays for the slot. Possible values:
|
|
slotSize |
Booking duration in minutes |
Error Handling
HTTP status: 400
{
"error": "1009",
"error_description": "Resource not found"
}
|
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 |
|
|
|
Resource with the specified |
|
|
|
Required parameter |
|
|
|
The Booking tool is disabled in the Bitrix24 settings |
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 |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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 |