---
title: "Get Policy"
method: GET
path: "/v1/time-off/policies/{policyId}"
---

# 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

- `policyId` string, uuid, required

## Query parameters

- `expand` string: Available expansions: `properties`, `payCode` See [Query Parameters](/using-the-api/query-parameters) for more information on expansions.

## Response `200`

- TimeOffPolicy
  - `id` string, uuid, required
  - `createdAt` string, 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
  - `name` string, required
  - `description` string, nullable, required
  - `accrualUnit` 'hours' | 'days', required
  - `yearlyAccrual` number, nullable: Allowance granted per accrual period, in `accrualUnit`.
  - `accrualPeriodRRule` string, nullable: RRULE describing when the balance resets.
  - `properties` unknown
  - `payCodeId` string, uuid, nullable, required: The pay code for which associated time will be paid out.
  - `payCode` PayCode
    - `id` string, uuid, required
    - `name` string, required
    - `shorthandName` string, required
    - `hexColor` string, required
    - `type` 'hours' | 'days' | 'money', required
    - `value` number, required
  - `enrolled` boolean: Only with `defaultsForProviderId`: whether that provider is enrolled in this policy.
  - `suggested` boolean: Only with `defaultsForProviderId`: most of the provider’s active teammates hold this policy. For vacation policies, only the single most common one is suggested.
  - `teammateCount` integer: Only with `defaultsForProviderId`: number of the provider’s active teammates enrolled in this policy.

## Other responses

- `400`: We follow the [RFC-9457](https://www.rfc-editor.org/rfc/rfc9457.html) Problem Detail specification for error responses. Errors should be identified by their `type` field. You can view extensions for each error response below.
- `404`: We follow the [RFC-9457](https://www.rfc-editor.org/rfc/rfc9457.html) Problem Detail specification for error responses. Errors should be identified by their `type` field. You can view extensions for each error response below.

---

[API](https://skmtc.dev/untetherlabs/apis/untether-labs-api.md) - [All operations](https://skmtc.dev/untetherlabs/apis/untether-labs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/untetherlabs/apis/untether-labs-api/revisions/143223935df3?raw)