Skip to main content
GET
List free, bookable slots for a location and appointment type

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Query Parameters

location_id
integer
required

Location to search

appointment_type_id
integer
required

Appointment type to book

practitioner_id
integer

Limit to one practitioner (omit for any)

from
string

Range start in the clinic timezone, YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (default: start of today)

Example:

"2026-09-01"

to
string

Range end (inclusive; a date means the end of that day). Default 7 days from from; at most 31 days

Example:

"2026-09-07"

visibility
enum<string>
default:online

Patient (online) or front-desk (all) view

Available options:
online,
all
max_per_day
integer

Cap on slots returned per day

Required range: 1 <= x <= 50
rescheduled_appointment_id
integer

When finding a new time for an existing appointment: its occupied time is treated as free for overlapping alternatives (its duration/columns are used), but its exact current start is not offered

Response

Slots in the clinic timezone, earliest first

data
object[]
meta
object