Shifts
Read and manage shifts.
List shifts
query Parameters
page0-based page number for offset pagination. Mutually exclusive with cursor.
cursor^[A-Za-z0-9._~\-]*$Opaque cursor for keyset pagination. Mutually exclusive with page. Clients must not parse or construct it; pass the nextCursor value back unchanged. Current tokens use the shared v1.BASE64... format.
sizeRequested page size. Defaults to 20 and must not exceed 100.
List shifts › Responses
OK
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
Get shift by external ID
path Parameters
externalIdGet shift by external ID › Responses
OK
availabilityShift availability code.
endTimeShift end time.
externalIdShift ID in the external system.
idShift ID.
nameShift label.
Shift weekly schedule.
startTimeShift start time.
Shift time zone.
Get shift by ID
path Parameters
idGet shift by ID › Responses
OK
availabilityShift availability code.
endTimeShift end time.
externalIdShift ID in the external system.
idShift ID.
nameShift label.
Shift weekly schedule.
startTimeShift start time.
Shift time zone.
Replace shift by ID
Replaces the writable state of the addressed shift.
path Parameters
idReplace shift by ID › Request Body
nameShift label.
null is invalid.
externalIdShift ID in the external system.
Omit or set null to clear it.
Replace shift by ID › Responses
OK
availabilityShift availability code.
endTimeShift end time.
externalIdShift ID in the external system.
idShift ID.
nameShift label.
Shift weekly schedule.
startTimeShift start time.
Shift time zone.
Update shift by ID
Partially updates the writable state of the addressed shift.
path Parameters
idUpdate shift by ID › Request Body
externalIdShift ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameShift label.
Omit to leave it unchanged. null is invalid.
Update shift by ID › Responses
OK
availabilityShift availability code.
endTimeShift end time.
externalIdShift ID in the external system.
idShift ID.
nameShift label.
Shift weekly schedule.
startTimeShift start time.
Shift time zone.