Get schedules

Get a list of schedules for your user.

GET

/ v1 / schedules

Authorization

X-API-Key

string

required

Header with the name X-API-Key where the value is your API key.

Response

200 - application/json - array

name

string

required

The name of the schedule.
isDefaultTimezone

boolean

required

Whether the schedule is the default timezone.
timezone

string

required

The timezone of the schedule.
schedule

object

required

The schedule details.
- monday
  
  array<object>
  
  An array of objects detailing start and end times.
  start
  
  string
  
  When the schedule starts, formatted HH:MM.
  
  end
  
  string
  
  When the schedule ends, formatted HH:MM.
- tuesday
  
  array<object>
  
  An array of objects detailing start and end times.
  start
  
  string
  
  When the schedule starts, formatted HH:MM.
  
  end
  
  string
  
  When the schedule ends, formatted HH:MM.
- wednesday
  
  array<object>
  
  An array of objects detailing start and end times.
  start
  
  string
  
  When the schedule starts, formatted HH:MM.
  
  end
  
  string
  
  When the schedule ends, formatted HH:MM.
- thursday
  
  array<object>
  
  An array of objects detailing start and end times.
  start
  
  string
  
  When the schedule starts, formatted HH:MM.
  
  end
  
  string
  
  When the schedule ends, formatted HH:MM.
- friday
  
  array<object>
  
  An array of objects detailing start and end times.
  start
  
  string
  
  When the schedule starts, formatted HH:MM.
  
  end
  
  string
  
  When the schedule ends, formatted HH:MM.
- saturday
  
  array<object>
  
  An array of objects detailing start and end times.
  start
  
  string
  
  When the schedule starts, formatted HH:MM.
  
  end
  
  string
  
  When the schedule ends, formatted HH:MM.
- sunday
  
  array<object>
  
  An array of objects detailing start and end times.
  start
  
  string
  
  When the schedule starts, formatted HH:MM.
  
  end
  
  string
  
  When the schedule ends, formatted HH:MM.