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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the calendar designation to fetch.
Response
OK
The ID of the calendar resource this designation is assigned to.
The ID of the clinic this designation belongs to.
The datetime this object was created.
The datetime this record was soft deleted.
Duration of the designation in minutes.
ISO 8601 formatted end datetime of the designation in UTC.
The unique identifier for this calendar designation.
Whether this record is soft deleted or not.
Whether this record follows a recurrence pattern.
The datetime this object was last modified; changes to related entities will not update this field.
Display name for this designation.
ISO 8601 formatted start datetime of the designation in UTC.
The IDs of the appointment kinds this designation is reserved for.
Structured recurrence pattern, if recurring.
Specific datetimes excluded from the recurrence pattern.
If this is an exception to a recurring designation, the ID of the parent.
Raw RFC 2445 RRule string, if recurring.