v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Schedules

List schedules

<small>Requires the sequences:read scope (or a broader one that includes it).</small>

Returns all schedules for the authenticated user.

get/v3/schedules

Response

List of schedules

idinteger

Unique identifier for the schedule

namestring

Name of the schedule

timezoneIdstring

IANA timezone identifier (e.g., "America/New_York")

excludeHolidaysboolean

Whether to skip sending on holidays from linked calendars

useProspectTimezoneboolean

Whether to use the prospect's timezone instead of the schedule timezone

useFollowUpScheduleboolean

Whether a separate follow-up schedule is enabled

isDefaultboolean

Whether this is the default schedule

statusstring

Current status of the schedule

Example response

[
  {
    "id": 1,
    "name": "Business hours",
    "timezoneId": "America/New_York",
    "excludeHolidays": true,
    "useProspectTimezone": false,
    "useFollowUpSchedule": false,
    "mainTimings": [
      {
        "weekDay": "Monday",
        "isActive": true,
        "timeRanges": [
          {
            "fromTime": {
              "hour": 9,
              "minute": 0
            },
            "toTime": {
              "hour": 17,
              "minute": 0
            }
          }
        ]
      }
    ],
    "followUpTimings": [],
    "isDefault": true,
    "status": "active"
  }
]