Skip to main content

Get Seasons

Retrieve pricing seasons for your account.

Endpointโ€‹

GET /v1/settings/seasons

Authenticationโ€‹

Requires an API key with the settings:read scope.

Responseโ€‹

Success (200 OK)โ€‹

{
"data": [
{
"id": 1,
"name": "Peak Season",
"type": "date",
"start_date": "2026-06-01",
"end_date": "2026-08-31",
"date_ranges": [
{ "start_date": "2026-06-01", "end_date": "2026-08-31" },
{ "start_date": "2026-12-01", "end_date": "2026-12-20" }
],
"start_time": null,
"end_time": null,
"days": {
"sunday": true,
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true
},
"created_at": "2025-01-01T00:00:00+00:00",
"updated_at": "2025-01-01T00:00:00+00:00"
},
{
"id": 2,
"name": "Weekend Rate",
"type": "days",
"start_date": null,
"end_date": null,
"date_ranges": [],
"start_time": null,
"end_time": null,
"days": {
"sunday": true,
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": true,
"saturday": true
},
"created_at": "2025-01-01T00:00:00+00:00",
"updated_at": "2025-01-01T00:00:00+00:00"
}
],
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-01-15T12:00:00+00:00"
}
}

Response Fieldsโ€‹

FieldTypeDescription
idintegerUnique identifier
namestringSeason name
typestringSeason type: date, time, or days
start_datestring|nullStart date (YYYY-MM-DD) of the season's first date range. Kept for backward compatibility; equals date_ranges[0].start_date.
end_datestring|nullEnd date (YYYY-MM-DD) of the season's first date range. Kept for backward compatibility; equals date_ranges[0].end_date.
date_rangesarrayAll date ranges a date season covers, ordered by start date. Each entry has start_date and end_date (YYYY-MM-DD). This is the authoritative list of when a date-based season applies. Empty array for time and days seasons.
start_timestring|nullStart time (HH:MM) for time-based seasons
end_timestring|nullEnd time (HH:MM) for time-based seasons
daysobjectDays of week the season applies to
created_atstringISO 8601 datetime
updated_atstringISO 8601 datetime

Season Typesโ€‹

TypeDescription
dateApplies during one or more date ranges
timeApplies during specific times of day
daysApplies on specific days of the week

Multiple date rangesโ€‹

A date season can cover several date ranges โ€” for example an early-season block and a holiday block that share the same rate. The full list of ranges is returned in date_ranges, and a booking date falls within the season if it lands inside any of those ranges.

Use date_ranges as the source of truth for date-based seasons. The top-level start_date and end_date remain for backward compatibility and always mirror the first range (date_ranges[0]); they do not describe any additional ranges. Seasons of type time or days cover no calendar ranges, so their date_ranges is an empty array.

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks settings:read scope

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/settings/seasons" \
-H "Authorization: Bearer eqd_live_abc123xyz789..."