Skip to main content
GET
Fetch a calendar event

Authorizations

Authorization
string
header
required

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

Path Parameters

calendar_event_id
integer
required

The ID of the calendar event to fetch.

Response

200 - application/json

OK

clinic_id
integer
required

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

description
string | null
required

Plain-text description of the event.

duration_minutes
integer
required

Duration of the event in minutes, computed from start and end datetimes.

end_datetime
string<date-time>
required

ISO 8601 formatted end datetime of the event in UTC.

id
integer
required

The unique identifier for this calendar event.

is_applicable_to_all_resources
boolean
required

Whether this event applies to all resources on the calendar.

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_recurring
boolean
required

Whether this record follows a recurrence pattern.

kind_id
integer
required

The ID of the calendar event kind.

kind_slug
string
required

The slug identifier of the calendar event kind.

modified
string<date-time>
required

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

should_block_appointments
boolean
required

Whether this event prevents appointments from being scheduled during its time window.

start_datetime
string<date-time>
required

ISO 8601 formatted start datetime of the event in UTC.

calendar_resource_ids
integer[]

The IDs of the calendar resources this event is assigned to.

recurrence
RecurrenceBreakdownSchema · object | null

Structured recurrence pattern, if recurring.

recurrence_excluded_datetimes
string<date-time>[]

Specific datetimes excluded from the recurrence pattern.

recurring_event_id
integer | null

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

rrule
string | null

Raw RFC 2445 RRule string, if recurring.