daily hands off every day at handoff_time, weekly every week on handoff_day at handoff_time. custom currently behaves like weekly; there is no custom shift length yet. Required on PUT; POST defaults to weekly.
dailyweeklycustom
In the app: Rotation frequency
All other fields5 fields
client_iduuid · nullable
handoff_dayinteger
Weekday of the weekly handoff, 0 = Sunday to 6 = Saturday, in the schedule's time zone. Daily rotations ignore it. A value outside 0 to 6 is stored as 1 (Monday).
In the app: Handoff day
handoff_timestring
Time of day of the handoff as HH:MM or HH:MM:SS in the schedule's time zone; empty means 09:00:00.
In the app: Handoff time
member_idsuuid[]
User IDs of the company members in rotation order. On update they replace the current members.
In the app: Team members
timezonestring
IANA time zone name; empty means UTC.
In the app: Timezone
Returns
A successful request returns 200 with application/json.
Response fields 1 top-level fields
Field
Type
Description
data
OnCallSchedule
OnCallSchedule · 28 fields
Field
Type
Description
created_at
string (date-time)
handoff_day
integer
Weekday of the weekly handoff, 0 = Sunday to 6 = Saturday.
handoff_time
string
HH:MM:SS in the schedule's time zone.
id
uuid
members
OnCallMember[] · nullable
Each item · 8 fields
Field
Type
Description
created_at
string (date-time)
id
uuid
schedule_id
uuid
sort_order
integer
user_id
uuid
email
string
first_name
string
last_name
string
name
string
organization_id
uuid
rotation_type
stringone ofdailyweeklycustom
timezone
string
updated_at
string (date-time)
client_id
uuid
current_oncall
OnCallMember
The person on call right now, an active override first; absent while nobody is.
OnCallMember · 8 fields
Field
Type
Description
created_at
string (date-time)
id
uuid
schedule_id
uuid
sort_order
integer
user_id
uuid
email
string
first_name
string
last_name
string
Errors
Only the errors this operation can return. Every error uses the same envelope.