Para agentes de IA: markdown desta página — /docs-content-en/entities/booking-wait-list/list.md índice da documentação — /llms.txt

Os artigos da documentação estão disponíveis atualmente em inglês.

List booking wait list records

GET /v1/booking-wait-list

Returns all wait list records — the queue of clients for whom no free booking slot was found.

Parameters

Parameter Type Required Description
Parameterfilter[createdWithin][from] (query) Typestring Requiredno DescriptionStart of the record creation date range. Passed together with filter[createdWithin][to]. Bitrix24 rejects the filter with 422 BITRIX_ERROR — see "Known specifics"
Parameterfilter[createdWithin][to] (query) Typestring Requiredno DescriptionEnd of the record creation date range. Passed together with filter[createdWithin][from]. Bitrix24 rejects the filter with 422 BITRIX_ERROR — see "Known specifics"

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.

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/booking-wait-list" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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 application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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))

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typearray DescriptionArray of wait list records
Fielddata[].id Typenumber DescriptionRecord identifier
Fielddata[].note Typestring | null DescriptionNote on the record. null — no note
Fieldmeta.total Typenumber DescriptionNumber of records in the response
Fieldmeta.hasMore Typeboolean DescriptionAlways false: the list is returned in full

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 5,
      "note": null
    },
    {
      "id": 27,
      "note": "Call back after 16:00"
    },
    {
      "id": 29,
      "note": null
    }
  ],
  "meta": {
    "total": 3,
    "hasMore": false
  }
}

Error response example

400 — the request contains the limit parameter:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionA parameter other than filter is passed, for example limit, offset or order. Message Only filter is supported; Bitrix24 ignores order
HTTP400 CodeINVALID_PARAMS Descriptionfilter contains a field other than createdWithin. Message Only createdWithin is supported; Bitrix24 ignores other wait list filters
HTTP400 CodeINVALID_PARAMS Descriptionfilter is neither an object nor a JSON-encoded object. Message filter must be an object
HTTP400 CodeINVALID_PARAMS Descriptionfilter[createdWithin] lacks from or to. Message createdWithin requires from and to date strings
HTTP422 CodeBITRIX_ERROR Descriptionfilter[createdWithin] is passed. Message Invalid date — see "Known specifics"
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is not passed
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key does not have the booking scope
HTTP429 CodeRATE_LIMITED DescriptionRequest rate exceeded. The effective cap is in the x-ratelimit-limit header
HTTP502 CodeBITRIX_RESULT_TOO_LARGE DescriptionThe wait list holds more than 5000 records. Message Narrow the wait list filter; more than 5000 records matched
HTTP502 CodeBITRIX_PAGINATION_INCOMPLETE DescriptionWhile 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
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionBitrix24 returned a list of an unexpected shape

Full list of common API errors — Errors.

Known specifics

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.

Record clients come from a separate request. The list does not include the clients of the records. They are returned by GET /v1/booking-wait-list/:id/clients.

See also