Vacation Tracker Docs
REST API v2API referenceAutomations

Get an automation

This API method returns a single automation, with the fields of its type. Requires `automations:read`. Errors: `404 AUTOMATION_TYPE_NOT_FOUND` (`type` is not one of the automation types) and `404 RESOURCE_NOT_FOUND` (no automation of the type in the path has this ID, including when the ID belongs to an automation of another type).

GET
/v2/automations/{type}/{id}

Authorization

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

Path Parameters

type*string

automation type. Any other value returns 404 AUTOMATION_TYPE_NOT_FOUND.

Value in"blackout-period" | "seniority-entitlement" | "entitlement-by-role" | "maximum-users-away" | "probation-period" | "leave-duration-limit" | "leave-request-notice-period"
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/automations/blackout-period/string"

{
  "data": {
    "id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "type": "blackout-period",
    "name": "End of year freeze",
    "isActive": true,
    "ownerId": "user-63b17e97-d38b-4586-8498-bb4f5d2e2c14",
    "createdAt": "2026-09-23T10:00:00.000Z",
    "locationIds": [
      "location-79c77ac8-e5bf-479f-9488-648a58379ff1"
    ],
    "departmentIds": [],
    "labelIds": [],
    "leaveTypeIds": [
      "leaveType-fcc1e5c5-ba93-479d-bd58-8f860ba10615"
    ],
    "startDate": "2026-12-20",
    "endDate": "2026-12-31",
    "recurring": true,
    "reason": "Year-end closing"
  }
}

{
  "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": "AUTOMATION_TYPE_NOT_FOUND",
    "name": "Automation type not found",
    "description": "The automation type was not found.",
    "resolution": "Use one of the automation types listed in the API reference.",
    "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 an automation

This API method creates an automation of the type in the path. Requires `automations:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user, and becomes the automation's owner (`ownerId`). It waits for the automation 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. - Send `name` plus the fields of the type. `CreateAutomationRequest` lists one request schema per type (for example `CreateBlackoutPeriodAutomationRequest` for `blackout-period`). Fields of another type, `id`, `type`, `isActive`, `ownerId` and other unknown fields fail validation. - The automation is created active (`isActive: true`); pause it with `PATCH /v2/automations/{type}/{id}` and `isActive: false`. - `locationIds`, `departmentIds` and `labelIds` limit the users the automation applies to; omitted or empty means everyone. `entitlement-by-role` does not accept them: it applies to the users with the label in `labelId`. - `name`, `reason` and `autoRejectResponse` fail validation when they look like HTML or script. - The acting user must be an approver or an admin; `seniority-entitlement` and `entitlement-by-role` automations can be created only by admins. - The company must have the automation's add-on active; otherwise the request fails with `403 AUTOMATION_ADDON_NOT_ACTIVE`. When the request returns `202`, the same error is reported on the operation. Errors: `400 VALIDATION_ERROR` (`details.fields`), `400 INVALID_REQUEST_BODY`, `403 ON_BEHALF_OF_NOT_ALLOWED`, `403 FORBIDDEN` and `403 AUTOMATION_ADMIN_REQUIRED` (the acting user may not create this automation), `403 AUTOMATION_ADDON_NOT_ACTIVE`, `404 AUTOMATION_TYPE_NOT_FOUND` (`type` is not one of the automation types), `409 DUPLICATE_NAME` (another automation already uses the name), and the `Idempotency-Key` codes.

Update an automation

This API method changes an automation. Requires `automations:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the change and returns the automation with `200`, or `202 Accepted` with an operation to poll. Send only the fields you want to change, from the fields of the automation's type plus `isActive`; at least one field is required. `UpdateAutomationRequest` lists the fields per type (for example `UpdateBlackoutPeriodAutomationRequest` for `blackout-period`); fields of another type fail validation. Your changes are merged with the automation's current values and the result is validated like a create, so everything you do not send is kept: - `isActive: false` pauses the automation and `isActive: true` re-enables it. - Arrays such as `leaveTypeIds`, `locationIds`, `departmentIds`, `labelIds` and `periods`, when sent, **replace** the current list. - For `leave-duration-limit`, send `null` for `minimumDuration` or `maximumDuration` to remove that limit; at least one of them must stay set, and `maximumDuration` cannot be less than `minimumDuration`. - An update that leaves the automation active, including re-enabling it, fails with `403 AUTOMATION_ADDON_NOT_ACTIVE` when the company's add-on for this automation is not active. Pausing is always allowed. - An acting user who is not an admin can change only automations they created (`ownerId`); `seniority-entitlement` and `entitlement-by-role` automations can be changed only by admins. Errors: `400 VALIDATION_ERROR` (`details.fields`), `400 INVALID_REQUEST_BODY`, `403 ON_BEHALF_OF_NOT_ALLOWED`, `403 FORBIDDEN` and `403 AUTOMATION_ADMIN_REQUIRED` (the acting user may not change this automation), `403 AUTOMATION_ADDON_NOT_ACTIVE`, `404 AUTOMATION_TYPE_NOT_FOUND`, `404 RESOURCE_NOT_FOUND` (no automation of the type in the path has this ID), `409 DUPLICATE_NAME` (another automation already uses the new name), and the `Idempotency-Key` codes.