v1

latestOpenAPI 3.1.02026-07-24112760.5 KB

Shifts

Get all shifts

Retrieve shifts for the current user's organization.

get/api/v1/shifts

Query parameters

startstring date-time required

Return shifts from this date eg. 2024-05-09T08:00:00. Can't request more than 1 week at a time.

endstring date-time required

Return shifts up until this date e.g 2024-05-09T08:00:00. Can't request more than 1 week at a time.

person_idsstring nullable

Filter shifts by person ids (e.g. '4,6,7,8')

emailsstring nullable

Filter shifts by e-mail addresses (e.g. 'simon@helloworld.com,susan@hello-world.com').

includestring nullable

Object detail to be included with each shift (e.g. 'activities,teams,roles,people,license_types')

exclude_unpublishedboolean nullable

Whether to exclude unpublished shifts

Response

Returns a list of shifts.

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

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

idinteger required

The unique ID of the shift

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

needs_publishing_calendarboolean nullable

Whether the shift needs re-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 re-publishing on slack

needs_publishing_smsboolean nullable

Whether the shift needs re-sending sms to the user

notesstring nullable

Any notes about the shift

organisation_idinteger required

The ID of the organisation the shift belongs to

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)

recurrence_idinteger nullable

The recurrence ID for the shift

request_idinteger nullable

ID of the request that created the shift

role_idinteger nullable

The ID of the role the shift belongs to

rrulestring nullable

The recurrence rule for the shift

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

time_publishedstring date-time nullable

When shift was last published