Special Hours

Get upcoming special hours — overrides of the weekly rental hours (see Rental Hours) for a date range or a single date. An entry either applies one time window to every covered date (all_days: true), or a weekly schedule (week_schedule, keyed by day-of-week 0–6, Sunday = 0) across its range — e.g. "Sep–Nov: Mon–Fri 10 AM–10 PM, weekends closed".

Priority on any date is: closure, then open dates (operating season), then special hours, then the weekly schedule. Among special hours, a single-date entry beats a range entry covering the same date. A weekly-schedule entry that doesn't define a weekday leaves that weekday on the normal weekly hours.

Endpoint

GET /v1/settings/special-hours

Authentication

Requires an API key with the settings:read scope.

Response

Success (200 OK)

{
  "data": [
    {
      "id": 11,
      "label": "Autumn season",
      "start_date": "2026-09-01",
      "end_date": "2026-11-30",
      "all_days": false,
      "open_time": null,
      "close_time": null,
      "closes_next_day": false,
      "week_schedule": {
        "0": { "is_open": false, "open_time": null, "close_time": null, "closes_next_day": false },
        "1": { "is_open": true, "open_time": "10:00:00", "close_time": "22:00:00", "closes_next_day": false },
        "5": { "is_open": true, "open_time": "10:00:00", "close_time": "22:00:00", "closes_next_day": false },
        "6": { "is_open": false, "open_time": null, "close_time": null, "closes_next_day": false }
      }
    },
    {
      "id": 12,
      "label": "Event day",
      "start_date": "2026-09-10",
      "end_date": "2026-09-10",
      "all_days": true,
      "open_time": "11:00:00",
      "close_time": "14:00:00",
      "closes_next_day": false,
      "week_schedule": null
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-01-15T12:00:00+00:00"
  }
}

Response Fields

Field	Type	Description
id	integer	Special hours entry ID
label	string | null	Optional owner-facing label
start_date	string	First covered date (Y-m-d, supplier-local calendar date)
end_date	string	Last covered date, inclusive
all_days	boolean	true when one time window applies to every covered date; false when week_schedule applies
open_time	string | null	Opening time when all_days is true (HH:mm:ss, supplier-local)
close_time	string | null	Closing time when all_days is true
closes_next_day	boolean	true when the all_days window closes in the early hours of the next day
week_schedule	object | null	When all_days is false: day-of-week (0–6, Sunday = 0) → { is_open, open_time, close_time, closes_next_day }. Weekdays not present follow the normal weekly hours

Only active entries whose range hasn't fully passed are returned, ordered by start date.

Errors

Status	Code	Description
401	unauthenticated	Missing or invalid API key
403	insufficient_scope	API key lacks the settings:read scope