Skip to main content

Get Schedule

Get a single schedule slot by ID.

Endpointโ€‹

GET /v1/experiences/{id}/schedules/{scheduleId}

Authenticationโ€‹

Requires an API key with the experiences:read scope.

Path Parametersโ€‹

ParameterTypeDescription
idintegerExperience ID
scheduleIdintegerSchedule ID

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/experiences/1/schedules/3" \
-H "Authorization: Bearer YOUR_API_KEY"

Responseโ€‹

Success (200 OK)โ€‹

{
"data": {
"id": 3,
"date": "2026-02-20",
"start_time": "10:00",
"capacity": 12,
"booked_slots": 5,
"held_slots": 0,
"available_slots": 7,
"available": true,
"guides": [
{
"id": 1,
"name": "John Smith"
},
{
"id": 2,
"name": "Jane Doe"
}
],
"timezone": "America/New_York",
"start_datetime_utc": "2026-02-20T15:00:00+00:00",
"end_datetime_utc": "2026-02-20T17:00:00+00:00",
"multi_day": false,
"days_nights": null,
"days_nights_short": null,
"created_at": "2026-02-01T10:00:00+00:00",
"updated_at": "2026-02-01T10:00:00+00:00"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-02-01T10:00:00+00:00"
}
}

Response Fieldsโ€‹

FieldTypeDescription
idintegerUnique schedule identifier
datestringDate of the schedule (YYYY-MM-DD)
start_timestringLocal start time (HH:MM)
capacityintegerMaximum participants
groups_capacityinteger|nullGroups-per-slot override for this departure (null = inherit the experience default). Shared group-priced experiences only
effective_groups_capacityinteger|nullThe cap actually in force โ€” the override above, else the experience's default_groups_capacity. null = unlimited
available_groupsinteger|nullGroups still bookable under that cap. null when no cap applies
booked_slotsintegerCurrently booked count
held_slotsintegerSpots customers are holding in their booking-page carts right now, in the same unit as booked_slots. Not booked, and not free to sell until the hold ends
available_slotsintegerSpots that can still be sold, the same number the booking page shows (gear out on rentals, closures and guides count). See the schedule fields
availablebooleanCan accept bookings
booking_option_idinteger|nullThe booking option this session runs for. null = it runs for every option
guidesarrayAssigned guides
timezonestringSchedule timezone
start_datetime_utcstringAuthoritative start instant (UTC, ISO 8601)
end_datetime_utcstring | nullAuthoritative return instant (UTC, ISO 8601). For a multi-day departure this is on a later day
multi_daybooleantrue when the departure returns on a later calendar day (one booking spanning several days)
days_nightsstring | nullTrip length in tour-operator phrasing (days first, nights = days โˆ’ 1), e.g. "5 Days / 4 Nights". null for single-day departures
days_nights_shortstring | nullCompact days-only trip length for tight UI (pills/chips), e.g. "5 Days". null for single-day departures
created_atstringISO 8601 datetime
updated_atstringISO 8601 datetime

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
403insufficient_scopeAPI key lacks experiences:read scope
404not_foundExperience or schedule not found