Get a location's leave policy for a leave type
This API method returns the active leave policy of a leave type in a location. Requires leave-policies:read.
Errors: 404 RESOURCE_NOT_FOUND (the location does not exist or is outside the key's data reach, or the leave type has no active policy in it; details.resource is location or leavePolicy).
Authorization
bearerAuth leave-policies:readAPI key sent as Authorization: Bearer vt_live_<secret>. See the Authentication and Scopes sections at the top of this document for how keys are created, which scopes exist and how the key owner's role limits them.
In: header
Scope: leave-policies:read
Path Parameters
resource ID.
leave type ID.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/locations/string/leave-policies/string"{
"data": {
"locationId": "location-79c77ac8-e5bf-479f-9488-648a58379ff1",
"leaveTypeId": "leaveType-fcc1e5c5-ba93-479d-bd58-8f860ba10615",
"isActive": true,
"quotaUnit": "days",
"daysPerYear": 20,
"hoursPerYear": 160,
"maxRolloverDays": 5,
"maxRolloverHours": 40,
"hasUnlimitedDays": false,
"isApprovalRequired": true,
"isReasonRequired": false,
"hideLeaveType": false,
"allowLeaveInPast": false,
"negativeBalanceAllowed": false,
"shortestLeaveInterval": "HALF-DAY",
"negativeBroughtForwardAllowed": false,
"accrual": {
"type": "MONTHLY",
"capRate": 2,
"firstEarningDate": "2026-01-01",
"periodStart": "2026-01-01",
"allowAdvanceUsage": false,
"pauseWhenUserDeactivated": true
},
"broughtForwardExpiration": {
"enabled": true,
"month": 3,
"day": 31
},
"toil": {
"enabled": false
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"name": "Unauthorized",
"description": "The API key is missing, malformed or not recognized.",
"resolution": "Send a valid API key in the Authorization header as Bearer followed by the full vt_live_ key.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}{
"error": {
"code": "INSUFFICIENT_SCOPE",
"name": "InsufficientScope",
"description": "The API key does not have the scopes this request needs.",
"resolution": "Add the scopes listed in details.requiredScopes to the key in the Vacation Tracker dashboard.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
"details": {
"requiredScopes": [
"leaves:write"
]
}
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"name": "ResourceNotFound",
"description": "The requested resource does not exist or is outside the data this key can access.",
"resolution": "Check the ID of the resource named in details.resource and that the key owner can see it.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}{
"error": {
"code": "RATE_LIMITED",
"name": "RateLimited",
"description": "Too many requests were sent in a short time.",
"resolution": "Wait a few seconds and retry, using the same Idempotency-Key for writes.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"name": "InternalError",
"description": "Something went wrong on our side.",
"resolution": "Retry later, and if it keeps happening, contact Vacation Tracker support and quote the requestId.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}Need help?
developers@vacationtracker.ioList a location's leave policies
This API method returns the active leave policies of a location, one per enabled leave type, in one response without pagination. Requires leave-policies:read. Disabled policies are left out.
Change a location's leave policy for a leave type
This API method changes the active leave policy of a leave type in a location. Requires leave-policies:write. The acting user is the key owner, or the X-On-Behalf-Of user. It waits for the change and returns the policy with 200, or 202 Accepted with an operation to poll.