Get Policies

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

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

Request

curl -X GET 'https://app.untetherlabs.com/api/v1/time-off/policies' \
  -H 'Authorization: Bearer $UNTETHER_API_KEY'

Response 200

{
  "items": [
    {
      "createdAt": "2024-11-20T07:43:34+0000",
      "type": "vacation",
      "name": "QC Vacation",
      "description": "Vacation policy for Quebec-based employees.",
      "accrualUnit": "hours",
      "properties": null,
      "payCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "payCode": {
        "name": "Overtime",
        "shorthandName": "OT",
        "hexColor": "#f97316",
        "type": "hours",
        "value": 1.5
      }
    }
  ],
  "cursor": "string"
}

Query parameters#

expandstring

Available expansions: properties, payCode

See Query Parameters for more information on expansions.

providerIduuid

Filter to only policies assigned to the given provider.

publishedOnlyboolean· default false

Filter to only policies with properties.published = true.

pageSizenumber· default 20 · min 1 · max 200

cursorstring

Response 200#

itemsTimeOffPolicy[]

Required

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

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

cursorstring

Errors#

validation400

Input validation failed.

Show extension members

pathstring

messagestring

Required