GET/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions

List office hours exceptions

Lists the exceptions for a specific office hours schedule. Use the schedule identifier to retrieve exceptions that override its regular hours on particular dates.

2 parameters
office_hours_schedule_idstringrequired
The unique identifier of the office hours schedule whose exceptions you want to list.
Intercom-Versionstringoptional
Selects the Intercom API version. Defaults to `2.17` when omitted; the schema defines the accepted version values.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns an office hours exception list containing exception objects in `data`, including their dates, types, names, time intervals, and recurrence settings.
typestringoptional
The type of the object - always `office_hours_exception.list`.
dataarray<OfficeHoursException>optional
An array of office hours exceptions.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the office hours schedule cannot be found.

2 documented failures

  • not_found

    Object not found

  • data_invalid

    Integration not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the schedule cannot be found. The office_hours_schedule_id path parameter must identify an existing office hours schedule.