# Список записей листа ожидания

`GET /v1/booking-wait-list`

Возвращает все записи листа ожидания — очереди клиентов, которым не нашлось свободного времени для записи.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|----------|
| `filter[createdWithin][from]` (query) | string | нет | Начало периода по дате создания записи. Передаётся в паре с `filter[createdWithin][to]`. Битрикс24 отклоняет отбор с `422 BITRIX_ERROR` — см. «Известные особенности» |
| `filter[createdWithin][to]` (query) | string | нет | Конец периода по дате создания записи. Передаётся в паре с `filter[createdWithin][from]`. Битрикс24 отклоняет отбор с `422 BITRIX_ERROR` — см. «Известные особенности» |

**Пагинация.** Постраничного вывода нет: список возвращает все записи одним ответом, до 5000. Параметры `limit`, `offset` и `order` не принимаются — запрос с ними отклоняется с `400 INVALID_PARAMS`.

## Примеры

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

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

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

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

const { data, meta } = await res.json()
console.log(meta.total, data.map((item) => item.note))
```

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

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

const { data, meta } = await res.json()
console.log(meta.total, data.map((item) => item.note))
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успехе |
| `data` | array | Массив записей листа ожидания |
| `data[].id` | number | Идентификатор записи |
| `data[].note` | string \| null | Заметка к записи. `null` — заметки нет |
| `meta.total` | number | Число записей в ответе |
| `meta.hasMore` | boolean | Всегда `false`: список приходит целиком |

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

```json
{
  "success": true,
  "data": [
    {
      "id": 5,
      "note": null
    },
    {
      "id": 27,
      "note": "Перезвонить после 16:00"
    },
    {
      "id": 29,
      "note": null
    }
  ],
  "meta": {
    "total": 3,
    "hasMore": false
  }
}
```

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

400 — в запросе передан параметр `limit`:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Only filter is supported; Bitrix24 ignores order"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | Передан параметр, кроме `filter`, например `limit`, `offset` или `order`. Сообщение `Only filter is supported; Bitrix24 ignores order` |
| 400 | `INVALID_PARAMS` | В `filter` есть поле, кроме `createdWithin`. Сообщение `Only createdWithin is supported; Bitrix24 ignores other wait list filters` |
| 400 | `INVALID_PARAMS` | `filter` — не объект и не JSON-объект. Сообщение `filter must be an object` |
| 400 | `INVALID_PARAMS` | В `filter[createdWithin]` нет `from` или `to`. Сообщение `createdWithin requires from and to date strings` |
| 422 | `BITRIX_ERROR` | Передан `filter[createdWithin]`. Сообщение `Invalid date` — см. «Известные особенности» |
| 401 | `MISSING_API_KEY` | Не передан `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа нет токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `booking` |
| 429 | `RATE_LIMITED` | Превышена частота запросов. Действующий потолок — в заголовке `x-ratelimit-limit` |
| 502 | `BITRIX_RESULT_TOO_LARGE` | В листе ожидания больше 5000 записей. Сообщение `Narrow the wait list filter; more than 5000 records matched` |
| 502 | `BITRIX_PAGINATION_INCOMPLETE` | Пока список собирался, записи листа сдвинулись и одна пришла дважды. Сообщение `Bitrix24 wait list pagination did not progress`. Повторите запрос |
| 502 | `BITRIX_RESPONSE_INVALID` | Битрикс24 вернул список неожиданной формы |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

**Отбор по дате создания не работает.** Битрикс24 отклоняет `filter[createdWithin]` с `422 BITRIX_ERROR` и сообщением `Invalid date` при любом формате даты. Запрашивайте список без `filter`: ответ содержит все записи листа ожидания.

**Клиенты записи — отдельным запросом.** Список не содержит клиентов записей. Их возвращает [`GET /v1/booking-wait-list/:id/clients`](/docs/entities/booking-wait-list/clients).

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

- [Получить запись листа ожидания](/docs/entities/booking-wait-list/get)
- [Создать запись в листе ожидания](/docs/entities/booking-wait-list/create)
- [Клиенты листа ожидания](/docs/entities/booking-wait-list/clients)
- [Лист ожидания записи](/docs/entities/booking-wait-list)
- [Ошибки](/docs/errors)