Untether LabsDevelopers

Get Requests

gethttps://app.untetherlabs.com/api/v1/time-off/requests

Get all time off requests. Can be filtered if necessary.

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

Query parameters#

providerIduuid

Filter to requests for a specific provider.

teamIdone of

Filter to requests for providers in specific teams.

Option 1 — uuid
uuid
Option 2 — uuid[]
uuid[]
policyIdone of

Filter to requests for specific policies.

Option 1 — uuid
uuid
Option 2 — uuid[]
uuid[]
startDatestring

Filter to requests whose start date is on or after the given timestamp.

endDatestring

Filter to requests whose end date is earlier than the provided timestamp.

statusTimeOffRequestStatus
pending
approved
rejected
cancelled
pending_sync
sync_failed
querystring
expandstring

Available expansions: policy, provider, rejectedBy

See Query Parameters for more information on expansions.

sortstring

Available fields: createdAt, startDate

See Query Parameters for more information on sorting.

pageSizenumber· default 20 · min 1 · max 200
cursorstring

Response 200#

itemsTimeOffRequest[]
Required
Show TimeOffRequest properties
createdAtstring
Required
statusTimeOffRequestStatus
Required
pending
approved
rejected
cancelled
pending_sync
sync_failed
startDatestring
Required
endDatestring
Required
policyIduuid
Required
policyTimeOffPolicy
Show TimeOffPolicy properties
createdAtstring
Required
typeenum
Required
bereavement
floating-holiday
holiday-pay
jury-duty
learning-and-development
paid-time-off
vacation
parental-leave
personal-day
sick
volunteer
weather
wellness
flex-day
marriage-code
unpaid-day
and 2 more
namestring
Required
descriptionstring | null
Required
accrualUnitone of
Required
Option 1 — AccrualUnit
enum
hours
days
propertiesany
payCodeIduuid | null
Required

The pay code for which associated time will be paid out.

payCodeone of
Option 1 — PayCode
namestring
Required
shorthandNamestring
Required
hexColorstring
Required
typeenum
Required
hours
days
money
valuenumber
Required
providerIduuid
Required
providerProvider
Show Provider properties
namestring | null
Required
emailstring
Required
hireDatestring | null
Required
statusenum
Required
onboarding
active
dismissed
unmanaged
teamIduuid | null
Required
licensedRegionsstring[]
Required
employmentTypeuuid | null
Required
notestring | null
Required
dailyHoursDailyHours
Required
datestring
Required

ISO timestamp of the date for the daily hours.

durationnumber
Required

Number of hours requested off for this day.

paidHoursnumber
Required

The total number of hours that will be paid out for this time off request.

rejectedByIduuid

Only present for rejected time off requests, the user who rejected the request.

rejectedByUser
typeUserType
Required
user
bot
namestring
Required
emailstring
Required
statusEmploymentStatus
Required
onboarding
active
dismissed
unmanaged
isAdminboolean
Required
rejectionReasonstring | null

Only present for rejected time off requests, reason may be null for unspecified.

syncErrorobject | null

Present for pending_sync requests, contains the latest Rippling sync status and error message.

statusenum
Required
success
failed
messagestring | null
Required
createdAtstring
Required
conflictResolutionenum | null

The shift conflict resolution strategy selected when this request was approved.

delete
deleteWithOpen
callout
calloutWithOpen
keep
keepWithOpen
null
isFullDayboolean | null

Whether the request blocks whole calendar days rather than the dailyHours windows. Null for requests created before this field existed; treated as full-day when the policy accrues in days.

cursorstring

Errors#

negative-range400

Time range end date must come after start date.

Show extension members
pathstring
validation400

Input validation failed.

Show extension members
pathstring
messagestring
Required