GET/office_hours_schedules

List office hours schedules

Lists the office hours schedules configured for the workspace. Use this endpoint to view the recurring schedules and their weekly hours.

1 parameter
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

2 status codes
200Returns an office hours schedule list containing schedule objects in `data`, including each schedule's name, time zone, weekly intervals, and 24/7 setting.
typestringoptional
The type of the object - always `office_hours_schedule.list`.
dataarray<OfficeHoursSchedule>optional
An array of office hours schedules.
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

Error handling

A 401 is returned when the request is unauthorized. The Intercom-Version header defaults to 2.17 when omitted; send a supported version when selecting one explicitly.