Skip to main content
GET
Fetch a resource schedule exception

Authorizations

Authorization
string
header
required

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

Path Parameters

resource_schedule_exception_id
integer
required

The ID of the resource schedule exception to fetch.

Response

200 - application/json

OK

calendar_resource_id
integer
required

The ID of the calendar resource this exception is for.

clinic_id
integer
required

The ID of the clinic this schedule exception 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 exception in UTC. Null when is_unavailable or use_clinic_hours is true.

id
integer
required

The unique identifier for this schedule exception.

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_unavailable
boolean
required

Whether the resource is entirely unavailable during this exception.

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 exception in UTC.

use_clinic_hours
boolean
required

Whether the resource should use the clinic's business hours for this exception day.