Fetch a calendar event
Fetches a calendar event by its ID.
A calendar event represents a non-appointment block on a clinic’s calendar (e.g., a staff meeting, lunch break, out-of-office, or clinic closure). Calendar events can be one-off or recurring, and may block appointment scheduling depending on configuration.
Events are scoped to specific calendar resources (providers) or can apply to all resources on a calendar. If an event is an exception to a recurring series, it references the parent recurring event.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the calendar event to fetch.
Response
OK
The ID of the clinic this calendar event belongs to.
The datetime this object was created.
The datetime this record was soft deleted.
Plain-text description of the event.
Duration of the event in minutes, computed from start and end datetimes.
ISO 8601 formatted end datetime of the event in UTC.
The unique identifier for this calendar event.
Whether this event applies to all resources on the calendar.
Whether this record is soft deleted or not.
Whether this record follows a recurrence pattern.
The ID of the calendar event kind.
The slug identifier of the calendar event kind.
The datetime this object was last modified; changes to related entities will not update this field.
Whether this event prevents appointments from being scheduled during its time window.
ISO 8601 formatted start datetime of the event in UTC.
The IDs of the calendar resources this event is assigned to.
Structured recurrence pattern, if recurring.
Specific datetimes excluded from the recurrence pattern.
If this event is an exception to a recurring series, the ID of the parent recurring event.
Raw RFC 2445 RRule string, if recurring.