Skip to main content
GET
/
schedulers
List schedulers
curl --request GET \
  --url https://api.reply.io/v3/schedulers \
  --header 'X-API-Key: <api-key>'
[
  {
    "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"
  }
]

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Response

List of schedulers

​
id
integer
required

Unique identifier for the scheduler

​
name
string
required

Name of the scheduler

​
timezoneId
string
required

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

​
status
string
required

Current status of the scheduler

​
excludeHolidays
boolean

Whether to skip sending on holidays from linked calendars

​
useProspectTimezone
boolean

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

​
useFollowUpSchedule
boolean

Whether a separate follow-up schedule is enabled

​
mainTimings
ScheduleTiming · object[]

Primary schedule timings for each day of the week

​
followUpTimings
ScheduleTiming · object[]

Follow-up schedule timings (used when useFollowUpSchedule is true)

​
isDefault
boolean

Whether this is the default scheduler