ListBusinessHours

ListBusinessHours returns all business hours for an Org.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response for listing business hours.

business_hours

array[object (BusinessHours) {7}]

business_hours

optional

The list of business hours

timezone

enum<string>

timezone

optional

The timezone.

Allowed values:

TIME_ZONE_AMERICA_PUERTO_RICOTIME_ZONE_AMERICA_NEW_YORKTIME_ZONE_AMERICA_INDIANAPOLISTIME_ZONE_AMERICA_CHICAGOTIME_ZONE_AMERICA_PHOENIXTIME_ZONE_AMERICA_DENVERTIME_ZONE_AMERICA_LOS_ANGELESTIME_ZONE_AMERICA_ANCHORAGETIME_ZONE_ASIA_MANILATIME_ZONE_ASIA_CALCUTTATIME_ZONE_ASIA_COLOMBOTIME_ZONE_PACIFIC_HONOLULUTIME_ZONE_CANADA_NEWFOUNDLANDTIME_ZONE_CANADA_ATLANTICTIME_ZONE_CANADA_CENTRALTIME_ZONE_CANADA_EAST_SASKATCHEWANTIME_ZONE_CANADA_EASTERNTIME_ZONE_CANADA_MOUNTAINTIME_ZONE_CANADA_PACIFICTIME_ZONE_CANADA_SASKATCHEWANTIME_ZONE_CANADA_YUKONTIME_ZONE_ETC_GREENWICHTIME_ZONE_ETC_UNIVERSALTIME_ZONE_EUROPE_LONDONTIME_ZONE_EUROPE_MADRIDTIME_ZONE_EUROPE_BERLINTIME_ZONE_EUROPE_BUCHARESTTIME_ZONE_AMERICA_MEXICO_CITYTIME_ZONE_MEXICO_BAJASURTIME_ZONE_MEXICO_BAJANORTETIME_ZONE_BRAZIL_ACRETIME_ZONE_BRAZIL_WESTTIME_ZONE_BRAZIL_EASTTIME_ZONE_BRAZIL_DENORONHATIME_ZONE_AUSTRALIA_DARWINTIME_ZONE_AUSTRALIA_ADELAIDETIME_ZONE_AUSTRALIA_SYDNEYTIME_ZONE_AUSTRALIA_BRISBANETIME_ZONE_AUSTRALIA_MELBOURNETIME_ZONE_AUSTRALIA_PERTHTIME_ZONE_PACIFIC_AUCKLANDTIME_ZONE_PACIFIC_CHATHAMTIME_ZONE_ASIA_SINGAPORETIME_ZONE_ASIA_JAPANTIME_ZONE_AMERICA_SANTIAGOTIME_ZONE_AMERICA_BOGOTATIME_ZONE_AMERICA_LIMA

last_updated

string <date-time>

last_updated

optional

A timestamp of when the BusinessHours object was last updated.

org_id

string

org_id

optional

The organization id of the BusinessHours object.

description

string

description

optional

The description of the BusinessHours object.

business_hours_id

string

business_hours_id

optional

The id of the BusinessHours object.

business_hours_name

string

business_hours_name

optional

The name of the BusinessHours object.

day_intervals

array[object (DayInterval) {3}]

day_intervals

optional

A list of time intervals of the BusinessHours object.

Example

{
  "business_hours": [
    {
      "timezone": "TIME_ZONE_AMERICA_PUERTO_RICO",
      "last_updated": "2019-08-24T14:15:22Z",
      "org_id": "string",
      "description": "string",
      "business_hours_id": "string",
      "business_hours_name": "string",
      "day_intervals": [
        {
          "day": "SUNDAY",
          "start": {
            "hour": 0,
            "minute": 0
          },
          "end": {
            "hour": 0,
            "minute": 0
          }
        }
      ]
    }
  ]
}

🔴500Server Error