[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-entities\u002Fbooking-wait-list\u002Flist":3,"docs-tabs-entities\u002Fbooking-wait-list\u002Flist":6},{"content":4,"lastmod":5},"# List booking wait list records\n\n`GET \u002Fv1\u002Fbooking-wait-list`\n\nReturns all wait list records — the queue of clients for whom no free booking slot was found.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `filter[createdWithin][from]` (query) | string | no | Start of the record creation date range. Passed together with `filter[createdWithin][to]`. Bitrix24 rejects the filter with `422 BITRIX_ERROR` — see \"Known specifics\" |\n| `filter[createdWithin][to]` (query) | string | no | End of the record creation date range. Passed together with `filter[createdWithin][from]`. Bitrix24 rejects the filter with `422 BITRIX_ERROR` — see \"Known specifics\" |\n\n**Pagination.** There is no paging: the list returns all records in one response, up to 5000. The `limit`, `offset` and `order` parameters are not accepted — a request with them is rejected with `400 INVALID_PARAMS`.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\n\nconst { data, meta } = await res.json()\nconsole.log(meta.total, data.map((item) => item.note))\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { data, meta } = await res.json()\nconsole.log(meta.total, data.map((item) => item.note))\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data` | array | Array of wait list records |\n| `data[].id` | number | Record identifier |\n| `data[].note` | string \\| null | Note on the record. `null` — no note |\n| `meta.total` | number | Number of records in the response |\n| `meta.hasMore` | boolean | Always `false`: the list is returned in full |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 5,\n      \"note\": null\n    },\n    {\n      \"id\": 27,\n      \"note\": \"Call back after 16:00\"\n    },\n    {\n      \"id\": 29,\n      \"note\": null\n    }\n  ],\n  \"meta\": {\n    \"total\": 3,\n    \"hasMore\": false\n  }\n}\n```\n\n## Error response example\n\n400 — the request contains the `limit` parameter:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Only filter is supported; Bitrix24 ignores order\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_PARAMS` | A parameter other than `filter` is passed, for example `limit`, `offset` or `order`. Message `Only filter is supported; Bitrix24 ignores order` |\n| 400 | `INVALID_PARAMS` | `filter` contains a field other than `createdWithin`. Message `Only createdWithin is supported; Bitrix24 ignores other wait list filters` |\n| 400 | `INVALID_PARAMS` | `filter` is neither an object nor a JSON-encoded object. Message `filter must be an object` |\n| 400 | `INVALID_PARAMS` | `filter[createdWithin]` lacks `from` or `to`. Message `createdWithin requires from and to date strings` |\n| 422 | `BITRIX_ERROR` | `filter[createdWithin]` is passed. Message `Invalid date` — see \"Known specifics\" |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESULT_TOO_LARGE` | The wait list holds more than 5000 records. Message `Narrow the wait list filter; more than 5000 records matched` |\n| 502 | `BITRIX_PAGINATION_INCOMPLETE` | While the list was being collected, the wait list records shifted and one record was returned twice. Message `Bitrix24 wait list pagination did not progress`. Retry the request |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned a list of an unexpected shape |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**Filtering by creation date does not work.** Bitrix24 rejects `filter[createdWithin]` with `422 BITRIX_ERROR` and the message `Invalid date` for any date format. Request the list without `filter`: the response contains all wait list records.\n\n**Record clients come from a separate request.** The list does not include the clients of the records. They are returned by [`GET \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients).\n\n## See also\n\n- [Get a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fget)\n- [Create a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fcreate)\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Booking wait list](\u002Fdocs\u002Fentities\u002Fbooking-wait-list)\n- [Errors](\u002Fdocs\u002Ferrors)\n","2026-10-13",{},1795000274554]