---
title: "getDashboard"
method: GET
path: "/getDashboard"
tags: ["Dashboard"]
---

# getDashboard

`GET /getDashboard`

Returns basic information about the current state of the hotel

## Query parameters

- `propertyID` string
- `date` string, date

## Response `200`

200 Response

- GetDashboardResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object — Data to be displayed on dashboard
    - `roomsOccupied` integer — Number of rooms occupied at the moment
    - `percentageOccupied` integer — Percentage of rooms occupied (rooms occupied/rooms total) for the current day
    - `arrivals` integer — Number of arrivals (check-ins) expected for the current day
    - `departures` integer — Number of departures (check-outs) expected for the current day
    - `inHouse` integer — Number of rooms occupied, and not expected to have a check-out for the current day
  - `message` string, nullable — To be used in case any error occurs (if success = false). If success = true, it does not exist.

---

[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)