v1

latestOpenAPI 3.1.02026-07-24112760.5 KB

Shifts

Create a new shift

Create a new shift with the given details.

post/api/v1/shifts

Request body

allow_alternative_timesboolean nullable

Whether person can request changes to the timing of their shift

approvedboolean nullable

Whether timesheet associated with the shift has been approved

archivedboolean nullable

Whether shift has been archived

auto_approve_changesboolean nullable

Whether shift change requests should be approved automatically

cascade_boolean nullable

Whether to update joined objects that are linked to the shift

client_idsinteger[] nullable

List of client IDs required for shift

clock_in_timestring date-time nullable

The time when the person clocked in (UTC)

clock_out_timestring date-time nullable

The time when the person clocked out (UTC)

created_at_clock_inboolean nullable

Whether shift was created as a result of clocking-in

endstring date-time required

The end time (UTC) of the shift e.g 2023-07-27 06:30:00+00

flex_hoursboolean nullable

Whether the shift has flexible hours

is_publishing_calendarboolean nullable

Whether the shift is re-syncing to the user's calendar

is_publishing_emailboolean nullable

Whether the shift is re-sending email to the user

is_publishing_slackboolean nullable

Whether the shift is re-publishing on slack

is_publishing_smsboolean nullable

Whether the shift is re-sending sms to the user

license_type_idsinteger[] nullable

List of license types IDs required for shift

needs_publishing_calendarboolean nullable

Whether the shift needs syncing to the user's calendar

needs_publishing_emailboolean nullable

Whether the shift needs re-sending email to the user

needs_publishing_slackboolean nullable

Whether the shift needs publishing on slack

needs_publishing_smsboolean nullable

Whether the shift needs re-sending sms to the user

notesstring nullable

Any notes about the shift

payment_idinteger nullable

The ID of the payment associated with the shift

people_requiredinteger nullable

The number of people required for the shift if unassigned

person_idinteger nullable

The ID of the person assigned to the shift (if any)

published_detailobject nullable

Details the shift that was published

recurrence_idinteger nullable

The ID of the recurrence the shift belongs to

request_idinteger nullable

ID of the request that created the shift

role_idinteger nullable

The ID of the role the shift belongs to (if any)

shift_type_idinteger nullable

The ID of the shift type

startstring date-time required

The start time (UTC) of the shift e.g 2023-07-27 06:30:00+00

statusstring nullable

The status of the shift

team_idinteger nullable

The ID of the team the shift belongs to (if any)

time_publishedstring date-time nullable

When shift was last published

Response

Successful Response