Vacation Tracker Docs
REST API v2API referenceLocations

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.

POST
/v2/locations/{id}/holidays

Authorization

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

Path Parameters

id*string

resource ID.

Header Parameters

Idempotency-Key?string

optional key (1 to 255 printable ASCII characters) that makes a write request safe to retry. Keys are retained for 24 hours per API key. Retrying with the same key and the same request within those 24 hours replays the original response (with the Idempotent-Replayed header). Reusing the key with a different request returns 422 IDEMPOTENCY_KEY_REUSED; retrying while the first request is still running returns 409 IDEMPOTENCY_REQUEST_IN_PROGRESS; an invalid key returns 400 INVALID_IDEMPOTENCY_KEY.

Length1 <= length <= 255
X-On-Behalf-Of?string

ID of the user the write is performed for. Requires the users:act-on-behalf scope, and the key owner must manage the target user; otherwise the request fails with 403 ON_BEHALF_OF_NOT_ALLOWED. Ignored on GET requests.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/locations/string/holidays" \  -H "Content-Type: application/json" \  -d '{    "name": "Christmas Day",    "startDate": "2026-12-25",    "recurring": true,    "transferIfFallsOnNonWorkingDay": true  }'
{
  "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
  }
}
{
  "operation": {
    "id": "pa_3f1c2b9e-8a47-4d5e-9c61-2b7f0e4a1d93",
    "status": "PENDING",
    "url": "/v2/operations/pa_3f1c2b9e-8a47-4d5e-9c61-2b7f0e4a1d93"
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "name": "ValidationError",
    "description": "A query parameter, body field or header failed validation.",
    "resolution": "Fix the fields listed in details.fields and send the request again.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
    "details": {
      "fields": [
        {
          "path": "startDate",
          "message": "\"startDate\" is required"
        }
      ]
    }
  }
}
{
  "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": "CONFLICT",
    "name": "Conflict",
    "description": "The request conflicts with the current state of the resource.",
    "resolution": "Read the resource again and retry with up-to-date values.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
  }
}

{
  "error": {
    "code": "LEAVE_NEGATIVE_BALANCE",
    "name": "LeaveNegativeBalance",
    "description": "The user does not have enough balance for this leave.",
    "resolution": "Shorten the leave, use a different leave type, or ask an admin to adjust the quota.",
    "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

List a location's holidays

This API method returns the holiday days of a location in one year, sorted by date, in one response without pagination. Requires `holidays:read`. - Each day is a separate entry: a multi-day holiday returns one entry per day, sharing `multiDayId`. - `year` defaults to the current UTC year. Errors: `400 VALIDATION_ERROR` (`year` is not a whole number) and `404 RESOURCE_NOT_FOUND` (the location does not exist or is outside the key's data reach).

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