Intercom API (unofficial showcase)
GET/office_hours_schedules/{id}

Retrieve an office hours schedule

Retrieves the details of a specific office hours schedule. Use the schedule identifier to view its recurring weekly hours and the time zone used to evaluate them.

2 parameters
idstringrequired
The unique identifier of the office hours schedule to retrieve.
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 schedule object containing its identifier, name, time zone, weekly intervals, 24/7 setting, and creation and update timestamps.
typestringoptional
The type of the object - always `office_hours_schedule`.
idstringoptional
The unique identifier for the office hours schedule.
namestringoptional
The name of the office hours schedule.
time_zone_namestringoptional
The IANA time zone the schedule's hours are evaluated in.
time_intervalsarray<OfficeHoursTimeInterval>optional
The open intervals that make up the weekly schedule.
twenty_four_sevenbooleanoptional
Whether the schedule is open 24/7.
created_atintegeroptional
The time the schedule was created as a Unix timestamp.
updated_atintegeroptional
The time the schedule was last updated as a Unix timestamp.
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 id path parameter must identify an existing office hours schedule.