VEvetcove
Scheduler

Fetch a calendar designation

Fetches a calendar designation by its ID.

A calendar designation defines a time window on a specific resource's schedule that is reserved for particular appointment kinds (e.g., a block reserved exclusively for surgeries or dental cleanings). Designations can be one-off or recurring.

If a designation is an exception to a recurring series, it references the parent recurring designation.

get/ext/v2/calendar-designations/{calendar_designation_id}/

Request

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

Path parameters

calendar_designation_idinteger required

The ID of the calendar designation to fetch.

Response

OK

appointment_kind_idsinteger[]

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

calendar_resource_idinteger required

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

clinic_idinteger required

The ID of the clinic this designation belongs to.

createdstring date-time required

The datetime this object was created.

deletedstring date-time nullable required

The datetime this record was soft deleted.

duration_minutesinteger required

Duration of the designation in minutes.

end_datetimestring date-time required

ISO 8601 formatted end datetime of the designation in UTC.

idinteger required

The unique identifier for this calendar designation.

is_deletedboolean required

Whether this record is soft deleted or not.

is_recurringboolean required

Whether this record follows a recurrence pattern.

modifiedstring date-time required

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

namestring required

Display name for this designation.

recurrence_excluded_datetimesstring[]

Specific datetimes excluded from the recurrence pattern.

recurring_designation_idinteger nullable

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

rrulestring nullable

Raw RFC 2445 RRule string, if recurring.

start_datetimestring date-time required

ISO 8601 formatted start datetime of the designation in UTC.

Changes

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