Get resource booking.v1.resource.get
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.get returns information about a resource by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Resource identifier. Can be obtained from 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 '{"id":15}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.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.resource.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 ResourceResult = {
resource: {
cancellationNotificationDelay: number | null,
confirmationCounterDelay: number | null,
confirmationNotificationDelay: number | null,
confirmationNotificationRepetitions: number | null,
confirmationNotificationRepetitionsInterval: number | null,
delayedCounterDelay: number | null,
delayedNotificationDelay: number | null,
description: string | null,
id: number,
infoNotificationDelay: number | null,
isCancellationNotificationOn: string,
isConfirmationNotificationOn: string,
isDelayedNotificationOn: string,
isFeedbackNotificationOn: string,
isInfoNotificationOn: string,
isMain: string,
isReminderNotificationOn: string,
name: string | null,
reminderNotificationDelay: number | null,
senderCode: string,
templateTypeConfirmation: string,
templateTypeDelayed: string,
templateTypeFeedback: string,
templateTypeInfo: string,
templateTypeReminder: string,
typeId: number,
},
}
try {
const response = await $b24.actions.v2.call.make<ResourceResult>({
method: 'booking.v1.resource.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.resource.id, result.resource.name, result.resource.typeId)
}
} 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 getResource() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.resource.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.resource.id, result.resource.name, result.resource.typeId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getResource)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.booking.v1.resource.get(
bitrix_id=15,
).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.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 resource: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.resource.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.resource.get',
[
'id' => 15
]
);
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.get", b24.Params{
"id": 15,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("booking.v1.resource.get: %w", err)
}
// The method wraps the response in an object with the "resource" key.
raw, ok := b24.Unwrap(res.Result, "resource")
if !ok {
return fmt.Errorf("no resource key in the response")
}
var item struct {
ConfirmationCounterDelay int `json:"confirmationCounterDelay"`
ConfirmationNotificationDelay int `json:"confirmationNotificationDelay"`
ConfirmationNotificationRepetitionsInterval int `json:"confirmationNotificationRepetitionsInterval"`
DelayedCounterDelay int `json:"delayedCounterDelay"`
DelayedNotificationDelay int `json:"delayedNotificationDelay"`
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ConfirmationCounterDelay, item.ConfirmationNotificationDelay)
Response Handling
HTTP status: 200
{
"result": {
"resource": {
"cancellationNotificationDelay": 600,
"confirmationCounterDelay": 10800,
"confirmationNotificationDelay": 86400,
"confirmationNotificationRepetitions": null,
"confirmationNotificationRepetitionsInterval": 10800,
"delayedCounterDelay": 300,
"delayedNotificationDelay": 300,
"description": null,
"id": 15,
"infoNotificationDelay": null,
"isCancellationNotificationOn": "Y",
"isConfirmationNotificationOn": "Y",
"isDelayedNotificationOn": "N",
"isFeedbackNotificationOn": "N",
"isInfoNotificationOn": "Y",
"isMain": "Y",
"isReminderNotificationOn": "Y",
"name": "Name",
"reminderNotificationDelay": -1,
"senderCode": "bitrix24",
"templateTypeConfirmation": "animate",
"templateTypeDelayed": "animate",
"templateTypeFeedback": "animate",
"templateTypeInfo": "inanimate",
"templateTypeReminder": "base",
"typeId": 1
}
},
"time": {
"start": 1746539524.292041,
"finish": 1746539524.356627,
"duration": 0.06458592414855957,
"processing": 0.018703937530517578,
"date_start": "2025-05-06T16:52:04+02:00",
"date_finish": "2025-05-06T16:52:04+02:00",
"operating_reset_at": 1746540124,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains a single field |
|
time |
Information about the request execution time |
Resource
Numeric and string fields are returned as null when no value is set. For example, a notification delay of 0 arrives as null in the response. The is* flags, the templateType* fields, and senderCode are always populated.
|
Name |
Description |
|
cancellationNotificationDelay |
Time in seconds after a booking is cancelled, after which the client receives the cancellation message |
|
confirmationCounterDelay |
Time in seconds before the booking, after which the unconfirmed booking counter is activated |
|
confirmationNotificationDelay |
Time in seconds before the booking, when the client receives the first confirmation message |
|
confirmationNotificationRepetitions |
Number of confirmation messages sent to the client, excluding the first one |
|
confirmationNotificationRepetitionsInterval |
Interval between booking confirmation messages, in seconds |
|
delayedCounterDelay |
Time in seconds after which the counter is activated in the calendar |
|
delayedNotificationDelay |
Time in seconds after which the late arrival message is sent to the client |
|
description |
Resource description |
|
id |
Resource identifier |
|
infoNotificationDelay |
Time in seconds after which the client receives the booking message |
|
isCancellationNotificationOn |
Message to the client after a booking is cancelled. Possible values:
|
|
isConfirmationNotificationOn |
Message to the client requesting booking confirmation. Possible values:
|
|
isDelayedNotificationOn |
Reminder when the client is running late. Possible values:
|
|
isFeedbackNotificationOn |
Feedback request. Possible values:
|
|
isInfoNotificationOn |
Booking message to the client. Possible values:
|
|
isMain |
How the resource is displayed. Possible values:
|
|
isReminderNotificationOn |
Booking reminder. Possible values:
|
|
name |
Resource name |
|
reminderNotificationDelay |
Time in seconds before the booking, at which the client receives the reminder. The value |
|
senderCode |
Code of the service that sends messages to the client. Possible values:
|
|
templateTypeConfirmation |
Message template type for booking confirmation. Possible values:
|
|
templateTypeDelayed |
Message template type for late arrival. Possible values:
|
|
templateTypeFeedback |
Message template type for the feedback request. Possible values:
|
|
templateTypeInfo |
Message template type for the booking message. Possible values:
|
|
templateTypeReminder |
Message template type for the reminder. The only value is |
|
typeId |
Resource type identifier. Information about the type can be retrieved using the booking.v1.resourceType.get method |
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 such |
|
|
|
Required parameter not provided |
|
|
|
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 |