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

Список клиентов брони

GET /v1/bookings/:id/clients

Возвращает контакты и компании CRM, которые записаны клиентами брони.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID брони. Список: GET /v1/bookings

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bookings/53/clients" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bookings/53/clients" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bookings/53/clients', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
const contacts = data.filter((client) => client.type.code === 'CONTACT')
console.log('Контакты брони:', contacts.map((client) => client.id))

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

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

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean true при успехе
data array Клиенты брони. У брони без клиентов — пустой массив
data[].id number ID контакта или компании CRM. Получить: GET /v1/contacts/:id, GET /v1/companies/:id
data[].type.code string Код типа клиента: CONTACT — контакт, COMPANY — компания. Справочник: GET /v1/booking-client-types
data[].type.module string Модуль типа клиента: crm

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3013,
      "type": {
        "code": "CONTACT",
        "module": "crm"
      }
    },
    {
      "id": 3149,
      "type": {
        "code": "COMPANY",
        "module": "crm"
      }
    }
  ]
}

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

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 — Ошибки.

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