Для AI-агентов: markdown этой страницы — /docs-content/entities/bookings/get.md индекс документации — /llms.txt

Получить бронирование

GET /v1/bookings/:id

Возвращает одно бронирование по идентификатору.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор бронирования

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bookings/27" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bookings/27" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bookings/27', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Бронирование:', data.name, data.resourceIds)

JavaScript — OAuth-приложение

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

const { success, data } = await res.json()

Поля ответа

Объект содержит 5 полей — все приведены в таблице ниже.

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор бронирования
data.name string | null Название бронирования. Может быть null
data.description string | null Описание бронирования. Может быть null
data.resourceIds number[] Идентификаторы резервируемых ресурсов
data.datePeriod object Период бронирования: from и to, у каждого timestamp (Unix-секунды) и timezone (IANA)

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "name": "Переговорная на демонстрацию",
    "description": "Бронь переговорной комнаты",
    "resourceIds": [1],
    "datePeriod": {
      "from": {
        "timestamp": 1780132384,
        "timezone": "Europe/Moscow"
      },
      "to": {
        "timestamp": 1780135984,
        "timezone": "Europe/Moscow"
      }
    }
  }
}

Пример ответа при ошибке

422 — бронирование не найдено:

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

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Бронирование с указанным id не найдено
422 BITRIX_ERROR id содержит нечисловое значение
403 SCOPE_DENIED API-ключ не имеет скоупа booking
401 MISSING_API_KEY Запрос отправлен без заголовка X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Смотрите также