UNuntetherlabs

Get Policies

get/v1/time-off/policies

Request

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

Query parameters

expandstring

Available expansions: properties, payCode

See Query Parameters for more information on expansions.

providerIdstring uuid

Filter to only policies assigned to the given provider.

defaultsForProviderIdstring uuid

Annotate every policy with enrolled, suggested and teammateCount for the given provider, derived from what their active teammates hold. Does not filter.

publishedOnlyboolean

Filter to only policies with properties.published = true.

pageSizenumber
cursorstring

Response

cursorstring

Example response

{
  "items": [
    {
      "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.