Skip to main content
GET
Fetch a resource schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

resource_schedule_id
integer
required

The ID of the resource schedule to fetch.

Response

200 - application/json

OK

calendar_resource_id
integer
required

The ID of the calendar resource this schedule is for.

clinic_id
integer
required

The ID of the clinic this resource schedule belongs to.

created
string<date-time>
required

The datetime this object was created.

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

end_datetime
string<date-time> | null
required

ISO 8601 formatted end datetime of the schedule in UTC. Null when use_clinic_hours is true.

id
integer
required

The unique identifier for this resource schedule.

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_recurring
boolean
required

Whether this record follows a recurrence pattern.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

start_datetime
string<date-time>
required

ISO 8601 formatted start datetime of the schedule in UTC.

use_clinic_hours
boolean
required

Whether this resource follows the clinic's business hours instead of a custom end time.

recurrence
RecurrenceBreakdownSchema · object | null

Structured recurrence pattern, if recurring.

rrule
string | null

Raw RFC 2445 RRule string, if recurring.