CLcloudbeds
Dashboard

getDashboard

Returns basic information about the current state of the hotel

get/getDashboard

Request

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

Query parameters

propertyIDstring

Property ID

datestring date

Return data for this date. Format: YYYY-MM-DD

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

No recorded changes to this operation across all 2 revisions of this API.