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

# GetBookingList

`POST /GetBookingList`

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` unknown, required

## 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.
      - `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.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)