Skip to main content
GET
Fetch a calendar designation

Authorizations

Authorization
string
header
required

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

Path Parameters

calendar_designation_id
integer
required

The ID of the calendar designation to fetch.

Response

200 - application/json

OK

calendar_resource_id
integer
required

The ID of the calendar resource this designation is assigned to.

clinic_id
integer
required

The ID of the clinic this designation 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.

duration_minutes
integer
required

Duration of the designation in minutes.

end_datetime
string<date-time>
required

ISO 8601 formatted end datetime of the designation in UTC.

id
integer
required

The unique identifier for this calendar designation.

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.

name
string
required

Display name for this designation.

start_datetime
string<date-time>
required

ISO 8601 formatted start datetime of the designation in UTC.

appointment_kind_ids
integer[]

The IDs of the appointment kinds this designation is reserved for.

recurrence
RecurrenceBreakdownSchema · object | null

Structured recurrence pattern, if recurring.

recurrence_excluded_datetimes
string<date-time>[]

Specific datetimes excluded from the recurrence pattern.

recurring_designation_id
integer | null

If this is an exception to a recurring designation, the ID of the parent.

rrule
string | null

Raw RFC 2445 RRule string, if recurring.