Untether LabsDevelopers

Get Policy

gethttps://app.untetherlabs.com/api/v1/time-off/policies/{policyId}

Path parameters#

policyIduuid
Required

Query parameters#

expandstring

Available expansions: properties, payCode

See Query Parameters for more information on expansions.

Response 200#

iduuid
Required
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
yearlyAccrualnumber | null

Allowance granted per accrual period, in accrualUnit.

accrualPeriodRRulestring | null

RRULE describing when the balance resets.

propertiesany
payCodeIduuid | null
Required

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

payCodeone of
Option 1 — PayCode
iduuid
Required
namestring
Required
shorthandNamestring
Required
hexColorstring
Required
typeenum
Required
hours
days
money
valuenumber
Required
enrolledboolean

Only with defaultsForProviderId: whether that provider is enrolled in this policy.

suggestedboolean

Only with defaultsForProviderId: most of the provider’s active teammates hold this policy. For vacation policies, only the single most common one is suggested.

teammateCountinteger

Only with defaultsForProviderId: number of the provider’s active teammates enrolled in this policy.

Errors#

validation400

Input validation failed.

Show extension members
pathstring
messagestring
Required
policy-not-found404

A specified policy does not exist in the system.