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

Получить запись

GET /v1/booking-wait-list/:id

Возвращает запись листа ожидания по идентификатору — номер записи и заметку к ней.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор записи. Список: GET /v1/booking-wait-list

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/booking-wait-list/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/booking-wait-list/27', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.id, data.note)

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

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

const { data } = await res.json()
console.log(data.id, data.note)

Поля ответа

Поле Тип Описание
success boolean true при успехе
data.id number Идентификатор записи
data.note string | null Заметка к записи. null — заметки нет

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

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "note": "Перезвонить после 15:00"
  }
}

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

404 — записи с таким id нет:

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

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Записи с таким id нет, в том числе удалённой или перенесённой в бронь. Сообщение Booking record not found
400 INVALID_PARAMS id — не целое положительное число. Сообщение id must be a canonical positive safe integer
401 MISSING_API_KEY Не передан X-Api-Key
401 TOKEN_MISSING У ключа нет токенов Битрикс24
403 SCOPE_DENIED У ключа нет скоупа booking
429 RATE_LIMITED Превышена частота запросов. Действующий потолок — в заголовке x-ratelimit-limit
502 BITRIX_RESPONSE_INVALID Битрикс24 вернул запись неожиданной формы

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

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

Клиенты записи — отдельным запросом. Запись не содержит клиентов. Их возвращает GET /v1/booking-wait-list/:id/clients.

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