Получить список бронирований booking.v1.booking.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: booking

Кто может выполнять метод: любой пользователь

Метод booking.v1.booking.list возвращает список бронирований по фильтру. Является реализацией списочного метода для бронирований.

Параметры метода

FILTER
object

Объект для фильтрации списка бронирований, описание доступных полей ниже

ORDER
object

Объект для сортировки списка бронирований. Направление сортировки может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

Значение по умолчанию — {id: 'ASC'}. Описание доступных полей ниже

Параметры filter

Название
тип

Описание

within
object

Объект для фильтрации по времени брони в формате {"dateFrom": "0", "dateTo": "1739262600"}, где

  • dateFrom — начало периода, число в формате timestamp
  • dateTo — конец периода, число в формате timestamp

Если объект передан, все параметры внутри него обязательны

client
object

Объект для фильтрации по клиенту, принимает массив объектов entities с полями

  • code — код типа клиента
  • module — модуль
  • id — идентификатор элемента

Доступные типы и модуль для клиентов возвращает метод booking.v1.clienttype.list.

Если объект передан, все параметры внутри него обязательны

Параметры order

Название
тип

Описание

id
string

Сортировка по идентификатору

dateFrom
string

Сортировка по дате начала

dateTo
string

Сортировка по дате окончания

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"within":{"dateFrom":0,"dateTo":1739262600},"client":{"entities":[{"code":"CONTACT","module":"crm","id":"1"},{"code":"COMPANY","module":"crm","id":"1"}]}},"order":{"id":"ASC","dateFrom":"DESC","dateTo":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.booking.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"within":{"dateFrom":0,"dateTo":1739262600},"client":{"entities":[{"code":"CONTACT","module":"crm","id":"1"},{"code":"COMPANY","module":"crm","id":"1"}]}},"order":{"id":"ASC","dateFrom":"DESC","dateTo":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.booking.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type BookingListResult = {
  booking: {
    datePeriod: {
      from: { timestamp: number; timezone: string }
      to: { timestamp: number; timezone: string }
    }
    description: string | null
    id: number
    name: string
    resourceIds: number[]
  }[]
}

try {
  // booking.v1.booking.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<BookingListResult>({
    method: 'booking.v1.booking.list',
    params: {
      filter: {
        within: {
          dateFrom: 0,
          dateTo: 1739262600,
        },
        client: {
          entities: [
            {
              code: 'CONTACT',
              module: 'crm',
              id: '1',
            },
            {
              code: 'COMPANY',
              module: 'crm',
              id: '1',
            },
          ],
        },
      },
      order: {
        id: 'ASC',
        dateFrom: 'DESC',
        dateTo: 'ASC',
      },
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.booking.length, result.booking)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function fetchBookingList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // booking.v1.booking.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'booking.v1.booking.list',
        params: {
          filter: {
            within: {
              dateFrom: 0,
              dateTo: 1739262600,
            },
            client: {
              entities: [
                {
                  code: 'CONTACT',
                  module: 'crm',
                  id: '1',
                },
                {
                  code: 'COMPANY',
                  module: 'crm',
                  id: '1',
                },
              ],
            },
          },
          order: {
            id: 'ASC',
            dateFrom: 'DESC',
            dateTo: 'ASC',
          },
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.booking.length, result.booking)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchBookingList)
</script>
try {
    $response = $b24Service
        ->core
        ->call(
            'booking.v1.booking.list',
            [
                'filter' => [
                    'within' => [
                        'dateFrom' => 0,
                        'dateTo'   => 1739262600,
                    ],
                    'client' => [
                        'entities' => [
                            [
                                'code'   => 'CONTACT',
                                'module' => 'crm',
                                'id'     => '1',
                            ],
                            [
                                'code'   => 'COMPANY',
                                'module' => 'crm',
                                'id'     => '1',
                            ],
                        ],
                    ],
                ],
                'order' => [
                    'id'       => 'ASC',
                    'dateFrom' => 'DESC',
                    'dateTo'   => 'ASC',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching booking list: ' . $e->getMessage();
}
BX24.callMethod(
    "booking.v1.booking.list",
    {
        filter: {
            within: {
                dateFrom: 0,
                dateTo: 1739262600,
            },
            client: {
                entities: [
                    {
                        "code": "CONTACT",
                        "module": "crm",
                        "id": "1"
                    },
                    {
                        "code": "COMPANY",
                        "module": "crm",
                        "id": "1"
                    }
                ]
            }
        },
        order: {
            id: "ASC",
            dateFrom: "DESC",
            dateTo: "ASC",
        }
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'booking.v1.booking.list',
    [
        'filter' => [
            'within' => [
                'dateFrom' => 0,
                'dateTo' => 1739262600,
            ],
            'client' => [
                'entities' => [
                    [
                        'code' => 'CONTACT',
                        'module' => 'crm',
                        'id' => '1'
                    ],
                    [
                        'code' => 'COMPANY',
                        'module' => 'crm',
                        'id' => '1'
                    ]
                ]
            ]
        ],
        'order' => [
            'id' => 'ASC',
            'dateFrom' => 'DESC',
            'dateTo' => 'ASC',
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "booking.v1.booking.list", b24.Params{
	"FILTER": b24.Params{
		"within": b24.Params{
			"dateFrom": 0,
			"dateTo":   1739262600,
		},
		"client": b24.Params{
			"entities": []b24.Params{
				{
					"code":   "CONTACT",
					"module": "crm",
					"id":     "1",
				},
				{
					"code":   "COMPANY",
					"module": "crm",
					"id":     "1",
				},
			},
		},
	},
	"ORDER": b24.Params{
		"id":       "ASC",
		"dateFrom": "DESC",
		"dateTo":   "ASC",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("booking.v1.booking.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "booking".
raw, ok := b24.Unwrap(res.Result, "booking")
if !ok {
	return fmt.Errorf("в ответе нет ключа booking")
}

var items []struct {
	ID   b24.ID `json:"id"`
	Name string `json:"name"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID)
}

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "booking": [
            {
                "datePeriod": {
                    "from": {
                        "timestamp": 1723446900,
                        "timezone": "Europe/Kaliningrad"
                    },
                    "to": {
                        "timestamp": 1723447800,
                        "timezone": "Europe/Kaliningrad"
                    }
                },
                "description": null,
                "id": 15,
                "name": "бронирование 15",
                "resourceIds": [
                    1,
                    2
                ]
            }
        ]
    },
    "time": {
        "start": 1724068028.331234,
        "finish": 1724068028.726591,
        "duration": 0.3953571319580078,
        "processing": 0.13033390045166016,
        "date_start": "2025-01-21T13:47:08+02:00",
        "date_finish": "2025-01-21T13:47:08+02:00",
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа.

Содержит массив объектов с информацией о бронированиях. Структура описана ниже

time
time

Информация о времени выполнения запроса

Бронирование

datePeriod
object

Период времени бронирования. Содержит поля from и to с информацией о времени начала и окончания бронирования

description
string

Описание бронирования. Может быть null

id
integer

Идентификатор бронирования

name
string

Название бронирования

resourceIds
array

Массив идентификаторов ресурсов, связанных с бронированием. Описание ресурсов можно получить методом booking.v1.resource.get

Обработка ошибок

HTTP-статус: 400

{
    "error": 422,
    "error_description": "Invalid date period"
}

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

1018

Empty resource collection

Пустой массив ресурсов или таких ресурсов не существует

0

Required fields:

Не передан обязательный параметр внутри filter

100

Could not find value for parameter

Не передан обязательный параметр

422

Invalid date period

Некорретный период времени

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение