Skip to content

Get availability rules and overrides for a schedule

GET
/appointments/schedules/{schedule_id}/availability

Return the weekly recurring availability rules and date-specific overrides for the given schedule. Availability entries without a date are weekly rules; entries with a date are one-time overrides for that calendar day.

Authorizations

Parameters

Path Parameters

schedule_id
required

Schedule integer ID.

integer
>= 1

Schedule integer ID.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string