Список ресурсов бронирования

GET /v1/booking-resources

Возвращает ресурсы бронирования, доступные ключу. Это единственный способ узнать значения для обязательного поля resourceIds при создании бронирования — начните отсюда, если бронирование создаётся впервые.

Метод возвращает весь каталог целиком и параметров постраничного вывода не принимает: meta.total всегда равен длине data, а meta.hasMore всегда false.

Параметры

Параметры можно комбинировать. Любой другой параметр, повторный параметр, массивная или объектная форма записи (typeId[], filter[typeId]) отклоняются с 400 INVALID_PARAMS до обращения к Битрикс24.

Сортировка наружу не выведена намеренно: обход всегда идёт по возрастанию id, и управляемый снаружи порядок нарушил бы гарантию полноты ответа.

Примеры

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

curl "https://vibecode.bitrix24.tech/v1/booking-resources?typeId=1" \
  -H "X-Api-Key: YOUR_API_KEY"

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

curl "https://vibecode.bitrix24.tech/v1/booking-resources?typeId=1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/booking-resources?typeId=1', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data, meta } = await res.json()
console.log(`Доступно ресурсов: ${meta.total}`)

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

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

const { data, meta } = await res.json()
console.log(`Доступно ресурсов: ${meta.total}`)

Связка «список ресурсов → бронирование» одним сценарием:

const res = await fetch('https://vibecode.bitrix24.tech/v1/booking-resources?searchQuery=переговорная', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data } = await res.json()
console.log(`Доступно ресурсов: ${data.length}`)

const room = data.find(r => r.isMain === 'Y') ?? data[0]

await fetch('https://vibecode.bitrix24.tech/v1/bookings', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    resourceIds: [room.id],
    datePeriod: {
      from: { timestamp: 1723446900, timezone: 'Europe/Moscow' },
      to: { timestamp: 1723447800, timezone: 'Europe/Moscow' },
    },
  }),
})

Поля ответа

Поле description не отдаётся намеренно: это свободный текст портала, в нём встречаются персональные данные и внутренние заметки, а для выбора ресурса оно не нужно. Параметры уведомлений и шаблонов в ответ тоже не попадают.

Ответ помечен заголовком Cache-Control: private, no-store — содержимое привязано к порталу и к личности ключа.

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

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Переговорная на 6 человек",
      "typeId": 1,
      "isMain": "Y"
    },
    {
      "id": 3,
      "name": "Переговорная с проектором",
      "typeId": 1,
      "isMain": "N"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

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

400 — передан неизвестный параметр:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Only typeId and searchQuery are supported query parameters."
  }
}

Ошибки

Ни один отказ не содержит частично собранных данных: ответ либо полный, либо это ошибка.

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

Известные особенности

Усечённый каталог не отдаётся. Портал, каталог которого не помещается в потолок, получает отказ, а не первые записи: неполный список без признака неполноты читался бы как весь каталог. Сузьте выборку фильтрами.

Полнота гарантируется для каталога, не менявшегося во время запроса. Битрикс24 не предоставляет снимок коллекции, поэтому создание или удаление ресурса параллельно с обходом может сдвинуть страницу. Ответ в этом случае остаётся корректным по форме, но может не содержать только что созданный ресурс или содержать только что удалённый.

Видимость решает Битрикс24. Метод возвращает то, что портал показывает личности, стоящей за ключом. Ключ сотрудника со скоупом booking метод вызвать может. Совпадёт ли его список со списком администратора, решает портал, а не платформа.

Ключ только для чтения подходит. Метод читающий, поэтому режим «только чтение» его не отбивает.

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

• Бронирования
• Создать бронирование
• Список бронирований
• Ошибки
• Лимиты и оптимизация