Vacation TrackerDeveloper Docs
REST API v2API referenceLeaves

Get a leave

This API method returns a single leave. Requires leaves:read. With expand, an embedded user or approver outside the key's data reach is left out, and only its ID is returned. With expand=leaveType, a key without leave-types:read-hidden gets Hidden Leave Type as leaveType.name when the leave's policy hides the leave type; leaveTypeId is always returned.

reason and statusReason need leaves:read-reason on top of leaves:read; without it both come back as null and every other field is unchanged.

Each expand value needs the read scope of the resource it embeds: user and approver need users:read, leaveType needs leave-types:read. Without it the request fails with 403 INSUFFICIENT_SCOPE, and details.expand names the values that asked for it. An embedded user carries location and department, which the request never named: a key without locations:read or departments:read keeps the request and loses the nested object.

Errors: 400 VALIDATION_ERROR (an unknown expand value), 403 INSUFFICIENT_SCOPE (an expand value whose read scope the key does not have) and 404 RESOURCE_NOT_FOUND (the leave does not exist, or belongs to a user outside the key's data reach).

GET
/v2/leaves/{id}

Authorization

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

Path Parameters

id*string

resource ID.

Query Parameters

expand?array<>

a comma-separated list of related resources to include in each leave. Options: user (the person on leave, requires users:read), approver (who approved or denied it, requires users:read) and leaveType (the leave type, requires leave-types:read). Each value needs the read scope of the resource it embeds.

Value in"user" | "approver" | "leaveType"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/leaves/string?expand=user%2CleaveType"
{
  "data": {
    "id": "leaveRequest-cfe5d39b-f1f0-45aa-85cd-ce93e637a262",
    "userId": "user-63b17e97-d38b-4586-8498-bb4f5d2e2c14",
    "approverId": "user-0f3a9c1e-6c2b-4a5d-9e7f-1b2c3d4e5f60",
    "autoApproved": false,
    "durationCalendarDays": 5,
    "durationWorkingDays": 5,
    "startDate": "2026-11-09",
    "endDate": "2026-11-13",
    "isFullDayLeave": true,
    "leaveTypeId": "leaveType-fcc1e5c5-ba93-479d-bd58-8f860ba10615",
    "locationId": "location-79c77ac8-e5bf-479f-9488-648a58379ff1",
    "departmentId": "team-0a21c25e-6925-4a5b-90ee-ecf82096c4f6",
    "status": "APPROVED",
    "reason": "Family trip",
    "statusReason": null,
    "approvedLevel": null,
    "createdAt": "2026-10-01T09:12:40.062Z"
  }
}
{
  "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": "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 leave

This API method creates a leave. Requires leaves:write. It waits for the leave to be created and returns it with 201; if that takes longer than the wait window it returns 202 Accepted with an operation to poll.

Update a leave

This API method changes an OPEN or APPROVED leave. Requires leaves:write. It waits for the change and returns the leave with 200, or 202 Accepted with an operation to poll.