Skip to main content

Availability Properties

This table defines the structure of the Availability entity returned by the API.

🔹 Core Properties

PropertyTypeRequiredDescription
idstringYesUnique identifier (UUID)
namestringNoDisplay name
weeklyScheduleobjectNoMap of day index 0..6 → array of {startTime,endTime}
overridesobjectNoMap of date string (YYYY-MM-DD) → array of intervals
unavailableDatesarrayNoArray of {startAt, endAt} ISO date-times
activebooleanYesWhether the availability is active
calendarobjectNoLinked Calendar object (when included)
calendarIdstring (UUID)YesCalendar ID this availability belongs to
servicesarrayNoLinked services (when included)
timezonestringNoDerived from linked calendar
createdAtstring (ISO)NoCreation datetime
updatedAtstring (ISO)NoLast update datetime

Notes:

  • calendar and services are exposed when included; otherwise use calendarId and serviceIds in operations.
  • timezone is derived from the linked calendar (Availability.timezone getter).

🧩 Example

{
"id": "1610c525-f19a-40d0-8cd1-03daba3d2d98",
"name": "Main Office Hours",
"weeklySchedule": {
"1": [{ "startTime": "09:00", "endTime": "17:00" }],
"2": [{ "startTime": "09:00", "endTime": "17:00" }]
},
"overrides": {
"2025-12-25": [{ "startTime": "10:00", "endTime": "15:00" }]
},
"unavailableDates": [
{ "startAt": "2025-12-31T00:00:00Z", "endAt": "2025-12-31T23:59:59Z" }
],
"active": true,
"calendarId": "550e8400-e29b-41d4-a716-446655440000",
"timezone": "America/New_York",
"createdAt": "2025-05-22T10:30:00Z",
"updatedAt": "2025-05-22T10:30:00Z"
}