GET /v1/time_off/policies — warp-api

Time Off

Get the time off policies for your company

get/v1/time_off/policies

Query parameters

limitstring

a number less than or equal to 100

afterIdstring

a string starting with "top_"

Example:top_1234

a string starting with "top_"

beforeIdstring

a string starting with "top_"

Example:top_1234

a string starting with "top_"

Response

Success

hasMoreboolean required

countinteger required

an integer

Example response

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

Changes

Changed in 8 of the 20 revisions of this API.10115

Mar 19, 2026a896c17cf98841See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 403
  response-body-type-changed
- ▲
  removed the required property _tag from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property requiredPermissions from the response with the 403 status
  response-required-property-removed
- ○
  added MissingRequiredPermissions ApiNotEnabled to the response body anyOf list for the response status 403
  response-body-any-of-added
Mar 13, 20266cfbdf910b801See the full diff
- ●
  added the new company:workplaces enum value to the requiredPermissions/items/scope response property for the response status 403
  response-property-enum-value-added
Mar 9, 2026768d9cb8d8d923See the full diff
- ▲
  the requiredPermissions/items/ response property's minItems was decreased from 2 to 0 for the response status 403
  response-property-min-items-decreased
- ▲
  the requiredPermissions/items/ response's property type/format changed from array/ to object/ for status 403
  response-property-type-changed
- ○
  removed subschema #1 subschema #2 from the requiredPermissions/items/ response property 'prefixItems' list for the response status 403
  response-property-prefix-items-removed
- ○
  added the required property requiredPermissions/items/level to the response with the 403 status
  response-required-property-added
- ○
  added the required property requiredPermissions/items/scope to the response with the 403 status
  response-required-property-added
Mar 9, 2026787281d7e9a21See the full diff
- ○
  added the non-success response with the status 403
  response-non-success-status-added
Jan 16, 2026d256b456551d1See the full diff
- ○
  added the required property count to the response with the 200 status
  response-required-property-added
Jan 5, 202619dde65e367924See the full diff
- ▲
  added the pattern ^top_ to the query request parameter afterId
  request-parameter-pattern-added
- ▲
  added the pattern ^top_ to the query request parameter beforeId
  request-parameter-pattern-added
- ○
  added subschema #1: startsWith("top_") to the id response property anyOf list for the response status 404
  response-property-any-of-added
- ○
  removed subschema #1 from the id response property anyOf list for the response status 404
  response-property-any-of-removed
- ○
  the data/items/id response's property pattern ^top_ was added for the status 200
  response-property-pattern-added
- ○
  the data/items/timeOffTypeId response's property pattern ^tot_ was added for the status 200
  response-property-pattern-added
Jan 4, 202651a25af9420b1See the full diff
- ▲
  response property id list-of-types was widened by adding types number to media type application/json of response 404
  response-property-list-of-types-widened
Dec 24, 20258d23b094927015See the full diff
- ▲
  the response's body type/format changed from array/ to object/ for status 200
  response-body-type-changed
- ○
  added the new optional query request parameter afterId
  new-optional-request-parameter
- ○
  added the new optional query request parameter beforeId
  new-optional-request-parameter
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the required property data to the response with the 200 status
  response-required-property-added
- ○
  added the required property hasMore to the response with the 200 status
  response-required-property-added

Full history