Retrieve team office hours

Request

You can retrieve the team's linked office hours schedule, or the workspace default if the team has no schedule of its own.

The team must belong to your workspace. An unknown, malformed, or other-workspace team id returns a 404 error. If the team has no linked schedule and the workspace has no default, the endpoint returns a 404 error.

Requires either the read_all or read_write_office_hours OAuth scope and permission to manage workload management. Set Intercom-Version: Preview.

Security

bearerAuth

Path

team_idstringrequired

The unique identifier of the team. Use GET /teams to list available team IDs.

Example:42

Intercom-Versionstring(intercom_version_preview)

Preview Intercom API version. Used for closed beta endpoints or other features under managed availability.

Default:"Preview"

Value:"Preview"

Example:Preview

curl -i -X GET \
  https://api.intercom.io/teams/42/office_hours \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Team office hours schedule

Bodyapplication/json

typestring

The type of the object - always office_hours_schedule.

Example:"office_hours_schedule"

idstring

The unique identifier for the office hours schedule.

Example:"123"

namestring

The name of the office hours schedule.

Example:"Standard Support Hours"

time_zone_namestring

The IANA time zone the schedule's hours are evaluated in.

Example:"America/New_York"

time_intervalsArray of objects(Office Hours Time Interval)

The open intervals that make up the weekly schedule.

twenty_four_sevenboolean

Whether the schedule is open 24/7.

Example:false

created_atinteger

The time the schedule was created as a Unix timestamp.

Example:1717200000

updated_atinteger

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

Example:1717200000

Response

{
  "type": "office_hours_schedule",
  "id": "123",
  "name": "Standard Support Hours",
  "time_zone_name": "America/New_York",
  "time_intervals": [
    { … }
  ],
  "twenty_four_seven": false,
  "created_at": 1717200000,
  "updated_at": 1717200000
}