Skip to main content
GET
/
v1
/
time-off
/
policies
/
{policyId}
Get Policy
curl --request GET \
  --url https://app.untetherlabs.com/api/v1/time-off/policies/{policyId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2024-11-20T07:43:34+0000",
  "type": "vacation",
  "name": "QC Vacation",
  "description": "Vacation policy for Quebec-based employees.",
  "accrualUnit": "hours",
  "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": "<unknown>",
  "payCode": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Overtime",
    "shorthandName": "OT",
    "hexColor": "#f97316",
    "type": "hours",
    "value": 1.5
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
policyId
string<uuid>
required

Query Parameters

​
expand
string

Available expansions: properties, payCode

See Query Parameters for more information on expansions.

Response

​
id
string<uuid>
required
​
createdAt
string
required
Example:

"2024-11-20T07:43:34+0000"

​
type
enum<string>
required
Available options:
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
Example:

"vacation"

​
name
string
required
Example:

"QC Vacation"

​
description
string | null
required
Example:

"Vacation policy for Quebec-based employees."

​
accrualUnit
enum<string>
required
Available options:
hours,
days
​
payCodeId
string<uuid> | null
required

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

​
properties
any
​
payCode
object