Sign in

v20

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-271727149.6 KB
Time Off

Get a specific time off policy by id

get/v1/time_off/policies/{id}

Path parameters

idstring required

a string starting with "top_"

Example:top_1234

a string starting with "top_"

Response

Success

idstring required

a string starting with "top_"

timeOffTypeIdstring required

a string starting with "tot_"

timeOffTypeNamestring required
paidboolean required
isUnlimitedboolean required
schedule'per_hour_worked' | 'monthly' | 'yearly' | 'unlimited' required
unit'hour' | 'day' required
namestring required
descriptionstring nullable required
hoursWorkedPerChunknumber nullable required
minutesPerChunknumber nullable required
minutesPerPeriodnumber nullable required

Example response

{
  "id": "top_1234",
  "timeOffTypeId": "tot_1234",
  "timeOffTypeName": "Vacation",
  "name": "Company-Wide Vacation Policy",
  "description": "Vacation policy for the whole company"
}