Cloudbeds

Cloudbeds GetReservation API

The GetReservation API from Cloudbeds — 1 operation(s) for getreservation.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.cloudbeds.com/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/openapi/cloudbeds-getreservation-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/json-schema/cloudbeds-reservation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/json-schema/cloudbeds-guest-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/json-schema/cloudbeds-rate-plan-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/json-structure/cloudbeds-reservation-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/json-structure/cloudbeds-guest-structure.json

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/rules/cloudbeds-rules.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/json-ld/cloudbeds-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/examples/cloudbeds-reservation-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/examples/cloudbeds-guest-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/examples/cloudbeds-rate-plan-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/cloudbeds/refs/heads/main/vocabulary/cloudbeds-vocabulary.yml

OpenAPI Specification

cloudbeds-getreservation-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Cloudbeds REST API v1.3 Access Token GetReservation API
  description: 'Cloudbeds REST API for property management - reservations, guests, rooms,

    rate plans, payments, housekeeping, webhooks, and reporting. v1.3 is the

    current documented version (v1.2 remains available). Authentication is via

    API keys or OAuth 2.0 for technology partners.

    '
  version: 1.3.0
servers:
- url: https://hotels.cloudbeds.com/api/v1.3
  description: Cloudbeds REST API v1.3
- url: https://hotels.cloudbeds.com/api/v1.2
  description: Cloudbeds REST API v1.2 (legacy)
security:
- apiKey: []
- oauth2:
  - read
  - write
tags:
- name: GetReservation
paths:
  /getReservation:
    get:
      summary: Get reservation
      parameters:
      - name: reservationID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Reservation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reservation'
      tags:
      - GetReservation
components:
  schemas:
    Reservation:
      type: object
      properties:
        reservationID:
          type: string
        guestName:
          type: string
        status:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        roomTypeID:
          type: string
        total:
          type: number
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://hotels.cloudbeds.com/api/v1.2/oauth
          tokenUrl: https://hotels.cloudbeds.com/api/v1.2/access_token
          scopes:
            read: Read access
            write: Write access