API Reference

Time Off

Policies

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve

get/v1/time_off/policies/{id}

Get a specific time off policy by id

Path ParametersExpand Collapse

id: string

a string starting with "top_"

ReturnsExpand Collapse

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"

HTTP

HTTP

TypeScript

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

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}