Skip to content

API reference · Schema

V1PeopleRosters

V1PeopleRosterscontract v1.people.rosters

itemsarray of objectrequired
- roster_idUuid7required
- outlet_idUuid7required
- week_startstring (date)required
  pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
- statusenum (2)required
  activecancelled
- shiftsarray of objectrequired
  - roster_shift_idUuid7required
  - staff_idUuid7required
  - starts_atIsoDatetimerequired
  - ends_atIsoDatetimerequired
  - role_keystringrequired
  - statusenum (2)required
    scheduledcancelled
next_cursorUuid7 | nullrequired

Used by

get/v1/people/rostersRosters with their shifts; week = the roster's Monday. A staff-role member gets only their own shifts