Skip to content
Home/
REST API Reference
/
/
Office Hours Exception

Office Hours Exception

An exception overrides a schedule's regular hours on a specific date, such as a public holiday.

typestring

The type of the object - always office_hours_exception.

Example:"office_hours_exception"
idstring

The unique identifier for the office hours exception.

Example:"456"
office_hours_schedule_idstring

The unique identifier for the schedule this exception belongs to.

Example:"123"
exception_datestring, (date)

The date the exception applies to, in YYYY-MM-DD format.

Example:"2026-12-25"
exception_typestring

closed means the workspace is closed all day; custom_hours replaces the regular hours with time_intervals.

Enum:"closed""custom_hours"
Example:"closed"
namestring or null

An optional name for the exception.

Example:"Christmas Day"
time_intervalsArray of objects or null(Office Hours Time Interval)

The open intervals for the exception date. null when exception_type is closed.

recurring_annuallyboolean

Whether the exception repeats every year on the same date.

Example:true
created_atinteger

The time the exception was created as a Unix timestamp.

Example:1717200000
updated_atinteger

The time the exception was last updated as a Unix timestamp.

Example:1717200000
{
  "type": "office_hours_exception",
  "id": "456",
  "office_hours_schedule_id": "123",
  "exception_date": "2026-12-25",
  "exception_type": "closed",
  "name": "Christmas Day",
  "time_intervals": [
    { … }
  ],
  "recurring_annually": true,
  "created_at": 1717200000,
  "updated_at": 1717200000
}