For AI agents: markdown of this page — /docs-content-en/entities/booking-resources/get.md documentation index — /llms.txt

Get: Booking resources

GET /v1/booking-resources/:id

Returns a booking resource by its identifier: name, type and the settings for client messages about bookings.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionResource identifier. List: GET /v1/booking-resources

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/booking-resources/51" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/booking-resources/51" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/booking-resources/51', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.name, data.typeId)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/booking-resources/51', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log(data.name, data.typeId)

Response fields

The isMain and is*NotificationOn switches are always true or false in the card, even if the strings "Y" / "N" were passed on write. Delays are in seconds.

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.id Typenumber DescriptionResource identifier. Pass it in resourceIds when creating a booking
Fielddata.name Typestring DescriptionResource name
Fielddata.description Typestring | null DescriptionResource description. null — not set
Fielddata.typeId Typenumber DescriptionResource type identifier. Type card: GET /v1/booking-resource-types/:id
Fielddata.isMain Typeboolean DescriptionMain resource
Fielddata.senderCode Typestring | null DescriptionService that sends messages to the client, for example bitrix24
Fielddata.isInfoNotificationOn Typeboolean DescriptionBooking info message to the client
Fielddata.isConfirmationNotificationOn Typeboolean DescriptionBooking confirmation request
Fielddata.isReminderNotificationOn Typeboolean DescriptionBooking reminder
Fielddata.isFeedbackNotificationOn Typeboolean DescriptionFeedback request
Fielddata.isDelayedNotificationOn Typeboolean DescriptionMessage to a client who is running late
Fielddata.isCancellationNotificationOn Typeboolean DescriptionBooking cancellation message to the client
Fielddata.infoNotificationDelay Typenumber | null DescriptionHow many seconds after the booking is made to send the booking info message
Fielddata.confirmationNotificationDelay Typenumber | null DescriptionHow many seconds before the booking to send the first confirmation request
Fielddata.confirmationNotificationRepetitions Typenumber | null DescriptionHow many times to repeat the confirmation request, not counting the first one
Fielddata.confirmationNotificationRepetitionsInterval Typenumber | null DescriptionInterval between repeats of the confirmation request
Fielddata.confirmationCounterDelay Typenumber | null DescriptionHow many seconds before the booking an unconfirmed booking enters the counter
Fielddata.reminderNotificationDelay Typenumber | null DescriptionHow many seconds before the booking to send the reminder. -1 — on the morning of the booking day
Fielddata.delayedNotificationDelay Typenumber | null DescriptionAfter how many seconds of lateness to send the message to the client
Fielddata.delayedCounterDelay Typenumber | null DescriptionAfter how many seconds of lateness the booking enters the calendar counter
Fielddata.cancellationNotificationDelay Typenumber | null DescriptionDelay of the booking cancellation message
Fielddata.templateTypeInfo Typestring DescriptionBooking info message template: inanimate, animate, inanimate_long
Fielddata.templateTypeConfirmation Typestring DescriptionConfirmation request template: inanimate, animate, inanimate_long
Fielddata.templateTypeReminder Typestring DescriptionReminder template, base
Fielddata.templateTypeFeedback Typestring DescriptionFeedback request template: inanimate, animate
Fielddata.templateTypeDelayed Typestring DescriptionLate-arrival message template: inanimate, animate

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 51,
    "description": "Appointments only",
    "typeId": 1,
    "isMain": true,
    "name": "Room 3",
    "senderCode": "bitrix24",
    "isInfoNotificationOn": false,
    "isConfirmationNotificationOn": false,
    "isReminderNotificationOn": false,
    "isFeedbackNotificationOn": false,
    "isDelayedNotificationOn": false,
    "isCancellationNotificationOn": false,
    "infoNotificationDelay": null,
    "confirmationNotificationDelay": 86400,
    "confirmationNotificationRepetitions": null,
    "confirmationNotificationRepetitionsInterval": 10800,
    "confirmationCounterDelay": 10800,
    "reminderNotificationDelay": -1,
    "delayedNotificationDelay": 300,
    "delayedCounterDelay": 300,
    "cancellationNotificationDelay": 600,
    "templateTypeInfo": "inanimate",
    "templateTypeConfirmation": "inanimate",
    "templateTypeReminder": "base",
    "templateTypeFeedback": "inanimate",
    "templateTypeDelayed": "inanimate"
  }
}

Error response example

404 — no resource with this id:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Booking record not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo resource with this id
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer. Message id must be a positive safe integer
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is not passed
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key does not have the booking scope
HTTP429 CodeRATE_LIMITED DescriptionRequest rate exceeded. The effective cap is in the x-ratelimit-limit header
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionBitrix24 returned a card of an unexpected shape

Full list of common API errors — Errors.

Known specifics

isMain comes in different forms in the card and in the list. The card returns true / false, while the resource list returns the strings "Y" / "N". Compare the value with its source in mind.

Work hours come from a separate request. The card does not include the resource schedule. It is returned by GET /v1/booking-resources/:id/slots.

See also