Vacation Tracker Docs
REST API v2API referenceLocations

List 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. Errors: `404 RESOURCE_NOT_FOUND` (the location does not exist or is outside the key's data reach).

GET
/v2/locations/{id}/leave-policies

Authorization

bearerAuth leave-policies:read
AuthorizationBearer <token>

API 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

id*string

resource 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"
{
  "data": [
    {
      "locationId": "location-79c77ac8-e5bf-479f-9488-648a58379ff1",
      "leaveTypeId": "leaveType-fcc1e5c5-ba93-479d-bd58-8f860ba10615",
      "isActive": true,
      "quotaUnit": "days",
      "daysPerYear": 20,
      "maxRolloverDays": 5,
      "hasUnlimitedDays": false,
      "isApprovalRequired": true,
      "isReasonRequired": false,
      "hideLeaveType": false,
      "allowLeaveInPast": false,
      "negativeBalanceAllowed": false,
      "shortestLeaveInterval": "FULL-DAY",
      "negativeBroughtForwardAllowed": false,
      "accrual": {
        "type": "NONE"
      },
      "broughtForwardExpiration": {
        "enabled": false
      },
      "toil": {
        "enabled": true,
        "shortestInterval": "ONE-HOUR",
        "requestsAllowedForUsers": true,
        "expiration": false
      }
    },
    {
      "locationId": "location-79c77ac8-e5bf-479f-9488-648a58379ff1",
      "leaveTypeId": "leaveType-88681ca1-4a47-4e4d-bc35-ffff86c0f54e",
      "isActive": true,
      "quotaUnit": "days",
      "daysPerYear": 0,
      "maxRolloverDays": 0,
      "hasUnlimitedDays": true,
      "isApprovalRequired": false,
      "isReasonRequired": true,
      "hideLeaveType": false,
      "allowLeaveInPast": true,
      "negativeBalanceAllowed": false,
      "shortestLeaveInterval": "HALF-DAY",
      "negativeBroughtForwardAllowed": false,
      "accrual": {
        "type": "NONE"
      },
      "broughtForwardExpiration": {
        "enabled": false
      },
      "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.io

Delete a holiday

This API method deletes a holiday. Requires `holidays:write`. No request body. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the deletion and returns `204`, or `202 Accepted` with an operation to poll. A holiday that repeats every year is deleted in every year, not just the requested one, and every day of a multi-day holiday is deleted. Errors: `403 ON_BEHALF_OF_NOT_ALLOWED`, `403 FORBIDDEN`, `404 RESOURCE_NOT_FOUND` (the location does not exist or is outside the key's data reach, or it has no holiday with this ID), and the `Idempotency-Key` codes.

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`).