Untether LabsDevelopers

Get Shifts

gethttps://app.untetherlabs.com/api/v1/shifts

Get shifts within a given time range.

This endpoint is paginated. See Pagination for how to page through the results.

Query parameters#

provideruuid
teamuuid
startDatestring

Used to inclusively filter shifts whose startDate is later than the provided start time, in yyyy-MM-dd format. Defaults to current date - 1 month.

endDatestring

Used to exclusively filter shifts whose endDate is earlier than the provided end time, in yyyy-MM-dd format. Defaults to current date + 1 month.

includeOpenboolean· default false
includeDisplayNamesboolean· default false
sortstring

Available fields: startDate

See Query Parameters for more information on sorting.

pageSizenumber· default 20 · min 1 · max 200
cursorstring

Response 200#

itemsShift[]
Required
Show Shift properties
createdAtstring
Required
versionnumber

Version number for optimistic locking. Include this when updating to detect conflicts.

provideruuid | null
Required

The provider of the shift. If null, the shift is an open shift.

providerNamestring | null

The display name of the provider. Only populated when the request opts in via includeDisplayNames.

startDatestring
Required
endDatestring
Required
segmentsShiftSegment[]
Required

The segments that make up a shift, ordered by startDate.

Show ShiftSegment properties
importedIdstring | null
Required

If a segment was created in an external system, this is the ID of the segment in that system.

createdAtstring
Required
roleuuid | null
Required

The role of the shift. Can be null if the shift is pulled from an external system.

roleNamestring | null

The display name of the segment's role. Only populated when the request opts in via includeDisplayNames.

roleColorstring | null

The hex color of the segment's role. Only populated when the request opts in via includeDisplayNames.

roleImportedIdstring

DEPRECATED The ID of the role in the external system. Once all roles are migrated to the system, this field will be removed.

additionalInfoany

DEPRECATED Additional information about the segment.

isBreakboolean
Required

Used to denote whether or not the provider will be on break during this segment.

isOnCallboolean
Required
typeenum
Required

The type of the segment.

working
Regular working segment
paid_break
Paid break segment
unpaid_break
Unpaid break segment
on_call
On-call segment
startDatestring
Required

The timestamp of when the shift starts.

endDatestring
Required

The timestamp of when the shift ends.

skillRequirementNullableSkillRequirement
Option 1 — SkillRequirementCondition
typeenum
Required
equal
skillstring· min length 1
Required
valuestring
Required
Option 2 — SkillRequirementGroup
typeenum
Required
and
or
entriesone of[]· min items 1
Required
Option 1 — SkillRequirementCondition
typeenum
Required
skillstring· min length 1
Required
valuestring
Required
Option 2 — SkillRequirementNestedGroup
typeenum
Required
entriesSkillRequirementCondition[]· min items 1
Required
labelsstring[]
Required

The label IDs associated with this shift segment.

payCodesShiftPayCode[]· max items 1
payCodeIduuid
Required

The pay code ID associated with this shift.

valuenumber

Only present for variable pay codes. The value of the pay code for this shift.

teamuuid | null
Required

The team that the shift is associated with.

notestring | null
Required

A note about the shift. Visible to providers.

isCalloutboolean
Required

Whether the shift is marked as a callout. Callout shifts are hidden from reads unless an endpoint explicitly includes them.

workRuleOverrideuuid | null
Required
cursorstring

Errors#

validation400

Input validation failed.

Show extension members
pathstring
messagestring
Required
unauthorized403

You do not have permission to perform this action.

Show extension members
actionstring
Required
resourcestring
Required
reasonstring