VEvetcove
Scheduler

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.

get/ext/v2/calendar-events/{calendar_event_id}/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/calendar-events/{calendar_event_id}/
  • Auth
    HTTP bearer

Path parameters

calendar_event_idinteger required

The ID of the calendar event to fetch.

Response

OK

calendar_resource_idsinteger[]

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

clinic_idinteger required

The ID of the clinic this calendar event belongs to.

createdstring date-time required

The datetime this object was created.

deletedstring date-time nullable required

The datetime this record was soft deleted.

descriptionstring nullable required

Plain-text description of the event.

duration_minutesinteger required

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

end_datetimestring date-time required

ISO 8601 formatted end datetime of the event in UTC.

idinteger required

The unique identifier for this calendar event.

is_applicable_to_all_resourcesboolean required

Whether this event applies to all resources on the calendar.

is_deletedboolean required

Whether this record is soft deleted or not.

is_recurringboolean required

Whether this record follows a recurrence pattern.

kind_idinteger required

The ID of the calendar event kind.

kind_slugstring required

The slug identifier of the calendar event kind.

modifiedstring date-time required

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

recurrence_excluded_datetimesstring[]

Specific datetimes excluded from the recurrence pattern.

recurring_event_idinteger nullable

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

rrulestring nullable

Raw RFC 2445 RRule string, if recurring.

should_block_appointmentsboolean required

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

start_datetimestring date-time required

ISO 8601 formatted start datetime of the event in UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.