UNuntetherlabs

Get Policy

get/v1/time-off/policies/{policyId}

Request

  • Base URL
    https://app.untetherlabs.com/api
  • URL
    https://app.untetherlabs.com/api/v1/time-off/policies/{policyId}
  • Auth
    HTTP bearer

Path parameters

policyIdstring uuid required

Query parameters

expandstring

Available expansions: properties, payCode

See Query Parameters for more information on expansions.

Response

idstring uuid required
createdAtstring required
type'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' | 'absence' | 'custom' required
namestring required
descriptionstring nullable required
accrualUnit'hours' | 'days' required
yearlyAccrualnumber nullable

Allowance granted per accrual period, in accrualUnit.

accrualPeriodRRulestring nullable

RRULE describing when the balance resets.

propertiesunknown
payCodeIdstring uuid nullable required

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

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.

Example response

{
  "createdAt": "2024-11-20T07:43:34+0000",
  "type": "vacation",
  "name": "QC Vacation",
  "description": "Vacation policy for Quebec-based employees.",
  "payCode": {
    "name": "Overtime",
    "shorthandName": "OT",
    "hexColor": "#f97316",
    "value": 1.5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.