CLcloudbeds
Reservation

getReservation

Changed on

Returns information on a booking specified by the reservationID parameter

get/getReservation

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getReservation
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:reservation

Query parameters

propertyIDstring

Property ID

reservationIDstring required

Reservation Unique Identifier. Obtained from one of the "Reservations" group methods

includeGuestRequirementsboolean

Includes guest requirements data in the response.

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

  • 6f4f997d5f7aRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status