List

get/v1/time_off/policies

Get the time off policies for your company

Query ParametersExpand Collapse

afterId: optional string

a string starting with "top_"

beforeId: optional string

a string starting with "top_"

limit: optional string

a number less than or equal to 100

ReturnsExpand Collapse

count: number

an integer

data: array of object { id, description, hoursWorkedPerChunk, 9 more }

id: string

a string starting with "top_"

description: string

hoursWorkedPerChunk: number

isUnlimited: boolean

minutesPerChunk: number

minutesPerPeriod: number

name: string

paid: boolean

schedule: "per_hour_worked" or "monthly" or "yearly" or "unlimited"

Accepts one of the following:

"per_hour_worked"

"monthly"

"yearly"

"unlimited"

timeOffTypeId: string

a string starting with "tot_"

timeOffTypeName: string

unit: "hour" or "day"

Accepts one of the following:

"hour"

"day"

hasMore: boolean

curl https://api.joinwarp.com/v1/time_off/policies \
    -H "x-api-key: $WARP_API_KEY"

{
  "count": 0,
  "data": [
    {
      "id": "top_1234",
      "description": "Vacation policy for the whole company",
      "hoursWorkedPerChunk": 0,
      "isUnlimited": true,
      "minutesPerChunk": 0,
      "minutesPerPeriod": 0,
      "name": "Company-Wide Vacation Policy",
      "paid": true,
      "schedule": "per_hour_worked",
      "timeOffTypeId": "tot_1234",
      "timeOffTypeName": "Vacation",
      "unit": "hour"
    }
  ],
  "hasMore": true
}

Returns Examples

{
  "count": 0,
  "data": [
    {
      "id": "top_1234",
      "description": "Vacation policy for the whole company",
      "hoursWorkedPerChunk": 0,
      "isUnlimited": true,
      "minutesPerChunk": 0,
      "minutesPerPeriod": 0,
      "name": "Company-Wide Vacation Policy",
      "paid": true,
      "schedule": "per_hour_worked",
      "timeOffTypeId": "tot_1234",
      "timeOffTypeName": "Vacation",
      "unit": "hour"
    }
  ],
  "hasMore": true
}