Vacation Tracker Docs
REST API v2API referenceLocations

Get a holiday

This API method returns a single holiday of a location, in any year. Requires `holidays:read`. When several days share the ID (a multi-day holiday), the earliest day is returned. Errors: `404 RESOURCE_NOT_FOUND` (the location does not exist or is outside the key's data reach, or the location has no holiday with this ID).

GET
/v2/locations/{id}/holidays/{holidayId}

Authorization

bearerAuth holidays: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: holidays:read

Path Parameters

id*string

resource ID.

holidayId*string

holiday ID.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/locations/string/holidays/string"
{
  "data": {
    "id": "holiday-4d2b7c1e-9a3f-4e5d-8c6b-1a2f3e4d5c6b",
    "locationId": "location-79c77ac8-e5bf-479f-9488-648a58379ff1",
    "name": "Christmas Day",
    "date": "2026-12-25",
    "isHalfDay": false,
    "type": "custom",
    "recurring": true
  }
}
{
  "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

Create a holiday

This API method creates a holiday in a location: a single day, a multi-day holiday, or a holiday that repeats every year. Requires `holidays:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the holiday to be created and returns its first day with `201`, or `202 Accepted` with an operation to poll. - `name` and `startDate` are required. `endDate` defaults to `startDate`, and must be in the same year. - `isHalfDay`, `transferIfFallsOnNonWorkingDay` and `recurring` default to `false`. For a recurring holiday that is not on the same date every year, describe the rule in `recurringRules`. - The start year must be from 2020 to next year, and the dates cannot overlap another holiday of the location. - Unknown fields fail validation. Errors: `400 VALIDATION_ERROR` (`details.fields`), `400 INVALID_REQUEST_BODY`, `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), `409 HOLIDAY_DATES_OVERLAP`, `422 HOLIDAY_INVALID_DATES` (the dates are in different years, the start is after the end, or the start year is outside 2020 to next year), and the `Idempotency-Key` codes.

Update a holiday

This API method changes a holiday. Requires `holidays:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the change and returns the holiday with `200`, or `202 Accepted` with an operation to poll. Send only the fields you want to change. Your changes are merged with the holiday's current values; for a multi-day holiday, the current `startDate` and `endDate` span all of its days. A request that changes nothing returns `200` with the unchanged holiday, without a write. Not every holiday can be changed in every way; these return `409 HOLIDAY_UPDATE_NOT_POSSIBLE`: - A `custom` holiday that repeats every year cannot be changed; delete it and create a new one. - An `imported` holiday can only be renamed or made non-recurring (`recurring: false`). Any other change, including making a non-recurring imported holiday recurring, is refused. Errors: `400 VALIDATION_ERROR` (`details.fields`), `400 INVALID_REQUEST_BODY`, `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), `409 HOLIDAY_UPDATE_NOT_POSSIBLE`, `409 HOLIDAY_DATES_OVERLAP`, `422 HOLIDAY_INVALID_DATES`, and the `Idempotency-Key` codes.