These docs are for v2.11. Click to read the latest docs for v2.12.

Get Scheduler

Get information of a Scheduler.

Sample Response

{
  "scheduler": {
    "id": "TOD8364363011",
    "label": "Scheduler 1",
    "timezone": "EST5EDT",
    "business_hours": {
        "business_hours_service_type": "Hangup",
        "business_hours_service_id": "Hangup",
        "after_hours_service_type": "Hangup",
        "after_hours_service_id": "Hangup",
        "lunch_hours_service_type": "Hangup",
        "lunch_hours_service_id": "Hangup",
        "monday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "tuesday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "wednesday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "thursday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "friday": {
            "business_open": "09:00",
            "business_close": "13:00",
            "lunch_start": "11:00",
            "lunch_end": "12:00"
        },
        "saturday": {
            "business_open": "00:00",
            "business_close": "00:00",
            "lunch_start": "00:00",
            "lunch_end": "00:00"
        },
        "sunday": {
            "business_open": "00:00",
            "business_close": "00:00",
            "lunch_start": "00:00",
            "lunch_end": "00:00"
        }
    },
    "holiday_hours": {
        "holiday_hours_service_type": "Phonenumber",
        "holiday_hours_service_id": "3214991000",
        "holidays": [
            {
                "holiday_name": "Holiday1",
                "holiday_type": "New Years Day",
                "custom_holiday_start": "",
                "custom_holiday_end": ""
            },
            {
                "holiday_name": "Holiday2",
                "holiday_type": "Martin Luther King Birthday",
                "custom_holiday_start": "",
                "custom_holiday_end": ""
            },
            {
                "holiday_name": "Holiday3",
                "holiday_type": "Independence Day",
                "custom_holiday_start": "",
                "custom_holiday_end": ""
            },
            {
                "holiday_name": "Holiday4",
                "holiday_type": "Custom",
                "custom_holiday_start": "01-01 00:00",
                "custom_holiday_end": "01-02 00:00"
            }
        ]
    },
    "override_mode": "Scheduler",
    "override_extension": ""
  }
}

Response Properties

PropertyTypeDescription
schedulerobjectScheduler
Language
Credentials
Header
Click Try It! to start a request and see the response here!