لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/entities/booking-wait-list/get.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Get an entry

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

Returns a wait list record by its identifier — the record number and its note.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionRecord identifier. List: GET /v1/booking-wait-list

Examples

curl — personal key

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

curl — OAuth application

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

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

JavaScript — OAuth application

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

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.id Typenumber DescriptionRecord identifier
Fielddata.note Typestring | null DescriptionNote on the record. null — no note

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "note": "Call back after 15:00"
  }
}

Error response example

404 — no record with this id:

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

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo record with this id, including one that was deleted or moved to a booking. Message Booking record not found
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer. Message id must be a canonical positive safe integer
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_RESPONSE_INVALID DescriptionBitrix24 returned a record of an unexpected shape

Full list of common API errors — Errors.

Known specifics

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

See also