---
title: "Dashboard composite data"
method: GET
path: "/dashboard"
tags: ["Booking Endpoints"]
---

# Dashboard composite data

`GET /dashboard`

Returns rooms, today's bookings, blocked times, opening time, slot length, and timezone in a single call.
Powers the ePOS home screen. Accepts optional `from` and `to` date parameters for a date range,
or a single `date` parameter. Defaults to today.

## Query parameters

- `date` string, date
- `from` string, date
- `to` string, date

## Headers

- `Authorization` string, required

## Response `200`

Dashboard data

- object
  - `rooms` Room[]
    - `id` integer — Same as code
    - `code` string — The code of the room - used internally by Jammed
    - `name` string — The name of the room
    - `description` string — The description of the room - you can set this in the admin interface
    - `space_for` integer — The capacity of the room
    - `order` integer
    - `twenty_four_hour_booking` boolean — Whether the room can be booked 24 hours a day
    - `space_type` string — The type of space the room is
    - `hex_colour` string — The hex colour of the room on the dashboard
    - `active` boolean — Whether the room is active for Jammed online bookings
    - `prices_set` integer — The count of prices set for the room
    - `price_to` string — The maximum price for the room
    - `price_from` string — The minimum price for the room
    - `images` object[] — The images of the room
      - `original` string — Image URL
    - `data` object — The hidden data of the room - can be set and used by back-end systems
  - `bookings` DashboardBooking[]
    - `id` integer
    - `code` string
    - `name` string — Customer name
    - `title` string — Display title, e.g. "John Doe (The Beatles)"
    - `band_name` string — Band/group name, empty string if none
    - `is_recording` boolean, nullable
    - `session_name` string, nullable
    - `block_colour_override` string, nullable — Hex colour override for the booking block
    - `studio_notes` string, nullable
    - `additional_notes` string, nullable
    - `number_expected` integer, nullable
    - `start` string — Start datetime as "YYYY-MM-DD HH:mm"
    - `end` string — End datetime as "YYYY-MM-DD HH:mm"
    - `split` string — Room code — use to match against rooms[].code
    - `room_name` string — Room display name
    - `has_amount_due` boolean
    - `amount_due` string — Formatted currency string e.g. "£1.00"
    - `payments_recieved` boolean — Whether any payments have been received (note: API uses this spelling)
    - `regular` boolean
    - `incomplete` boolean
    - `show_studio_notes` boolean
    - `extras_summary` string[] — Array of extra item descriptions (empty array if none)
    - `link` string — Admin link path e.g. "/admin/bookings/R9XT9J1JFX"
    - `type` string — "booking" or "blocked"
    - `class` string — CSS class for the booking block e.g. "room-l3j5nwp8"
  - `blocked_times` BlockedTime[]
    - `id` integer
    - `room_id` integer
    - `reason` string
    - `start_at` integer — Unix timestamp
    - `end_at` integer — Unix timestamp
    - `start_time` string — Format: YYYY-MM-DD HH:MM
    - `end_time` string — Format: YYYY-MM-DD HH:MM
    - `room` object
      - `id` integer
      - `name` string
      - `code` string
  - `opening_time` integer — Opening time in seconds from midnight (e.g. 32400 = 9am)
  - `slot_length` integer — Slot length in seconds (e.g. 3600 = 1 hour)
  - `timezone` string

---

[API](https://skmtc.net/jammed-org/apis/jammed-bookings-api.md) · [All operations](https://skmtc.net/jammed-org/apis/jammed-bookings-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jammed-org/jammed-bookings-api/versions/3fc6a6f91b06/schema)