---
title: "GetBookingList"
method: POST
path: "/GetBookingList"
tags: ["Bookings"]
---

# GetBookingList

`POST /GetBookingList`

## Request

- Base URL: `https://api.your-ota.com/cloudbeds`
- URL: `https://api.your-ota.com/cloudbeds/GetBookingList`
- Auth: API key in query parameter `shared_secret`

Returns a list of bookings/reservations which have not been previously
downloaded or have been modified.

The pull interval can be freely set. For channels that do not support the
`CreateBooking` callback the interval is usually set to pull bookings every
5 minutes. If `CreateBooking` is supported then the `GetBookingList` will
be used as a fallback every 30 minutes.

The OTA can also send Cloudbeds a `NotifyBooking` callback to inform about
new bookings available to be polled.

## Request body

- object
  - `mya_property_id` integer, required: Property ID on the Cloudbeds channel manager
  - `ota_property_id` string, required: Username, login or property ID on the OTA
  - `ota_property_password` string, required: Password for property on your OTA. In case the OTA does not use passwords this will be an empty string.
  - `ota_property_sub_id` string, required: Property ID on the OTA, if OTA supports multiple properties under one `ota_property_id`/`ota_property_password` combination. See `GetSubProperties` for more details.
  - `guid` string, required: Request reference ID, used for debugging and support requests.
  - `shared_secret` string, required: Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.
  - `ota_cid` string, required: OTA ID as given by Cloudbeds
  - `verb` 'GetBookingList', required
  - `ota_booking_version` string, nullable, required: With each request we send along `ota_booking_version`, which has the format `YYYY-MM-DD HH:MM:SS` and indicates the time in UTC we last successfully requested bookings. It can be `null` if no successful response has been received so far. Please use `ota_booking_version` to only return to us new or modified bookings made since then. To ensure that no booking are skipped due to a time-offset between your and our servers make sure to always reduce 5 or more minutes from the time given. Example: we provide 2017-06-22 12:09:19, then please return all new/modified/cancelled bookings since 2017-06-22 12:04:19 (5 minutes before the time sent). If `ota_booking_version` is `null` please return all bookings.

## Response `200`

GetBookingList

- union
  - object
    - `success` true, required
    - `Bookings` object[], required: List of bookings to be retrieved with `GetBookingId`.
      - `booking_id` string, required: Unique booking ID on the OTA. Maximum of 64 characters.
      - `version` string: Most recent version number of the booking, if the OTA wants to support retrieval of different versions of bookings. Not commonly implemented. Passed back unchanged as `version` on `AckBooking`, so a monotonic value here lets you tell which retrieval of the booking is being acknowledged.
      - `use_pci_url` boolean: Optional. Controls which endpoint Cloudbeds uses to retrieve this booking's full details with `GetBookingId`. Set to `true` to fetch it from the channel's configured PCI endpoint instead of the standard API URL — use this for bookings whose card data can only be returned from a PCI-compliant endpoint. Set to `false` to force the standard API URL even when a PCI endpoint is configured. If omitted, the channel-level default applies (the PCI endpoint is used for all `GetBookingId` calls only when one is configured). Requires a PCI endpoint to be configured on the channel for `true` to take effect; otherwise the standard API URL is used.
  - ResponseError
    - `errors` object[], required: Array of error objects.
      - `id` integer, required: Error code. Check the "Error Codes" section of the specification for valid codes.
      - `msg` string: Optional error string to give more details about the error. Myallocator localises errors into different langauges, so this field is generally ignored and only useful for debugging.
    - `success` false, required

---

[API](https://skmtc.dev/cloudbeds/apis/cloudbeds-ota-build-to-us-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/cloudbeds-ota-build-to-us-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/cloudbeds-ota-build-to-us-api/revisions/baef9c11c34d?raw)