Skip to main content
GET
Get bookable time slots for a scheduler
Compute the bookable time slots for a scheduler over a date range — exactly what a guest sees on the public booking page, through the same shared engine: live roster resolution, calendar free/busy + working hours, the min-booking-notice floor, and the existing-bookings buffer/overbooking screen against Aura’s own calls table. Semantics:
  • start_date/end_date are inclusive UTC calendar days; the range spans at most 31 days and must start today or later.
  • start and end accept instants with offsets instead of the date fields. Send exactly one input per edge. Start is inclusive and end is exclusive for slot start times. An instant start must be now or later.
  • The window is additionally clamped to the link’s booking horizon (available_days_in_future).
  • Slot times are unix seconds (UTC); timezone is echoed back for client-side formatting only.
  • An empty roster or a fully-booked range returns slots: [] (200).
Expected failures are typed, never a bare 500:
  • 400 — invalid date range
  • 422 — the link’s configuration was rejected by the availability provider (e.g. a misconfigured grant or calendar)
  • 502 — the availability provider is degraded (5xx / timeout)

Path Parameters

id
string
required

Scheduler ID (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

start_date
string

Inclusive start UTC day, today or later. Send start_date or start, not both.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-10"

end_date
string

Inclusive end UTC day. Send end_date or end, not both. The window spans at most 31 days.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-17"

start
string<date-time>

Inclusive start instant with an offset, now or later. Alternative to start_date.

Example:

"2026-07-10T20:00:00-04:00"

end
string<date-time>

Exclusive end instant with an offset. Alternative to end_date. Slot start times fall before this instant.

Example:

"2026-07-17T20:00:00-04:00"

timezone
string

IANA timezone echoed back for formatting. Defaults to the scheduler's timezone.

Example:

"Europe/Berlin"

Response

Successfully computed availability

data
object
required
success
enum<boolean>
required
Available options:
true