List automations of a type

This API method returns every automation of the type in the path, active and paused, in one response without pagination. Requires automations:read. Automations are company-wide: they are not limited by the key's data reach.

Each automation has the fields of its type; Automation lists one schema per type (for example BlackoutPeriodAutomation for blackout-period). locationIds, departmentIds and labelIds are always arrays, and an empty array means the automation applies to everyone; entitlement-by-role automations have no filters.

Errors: 404 AUTOMATION_TYPE_NOT_FOUND (type is not one of the automation types).

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"

Response Body

`application/json`

curl -X GET "https://example.com/v2/automations/blackout-period"

{
  "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"
    },
    {
      "id": "5d6e7f80-a1b2-4c3d-9e4f-0a1b2c3d4e5f",
      "type": "blackout-period",
      "name": "Product launch",
      "isActive": false,
      "ownerId": "user-0f3a9c1e-6c2b-4a5d-9e7f-1b2c3d4e5f60",
      "createdAt": "2026-03-02T08:15:00.000Z",
      "locationIds": [],
      "departmentIds": [
        "team-0a21c25e-6925-4a5b-90ee-ecf82096c4f6"
      ],
      "labelIds": [],
      "leaveTypeIds": [
        "leaveType-fcc1e5c5-ba93-479d-bd58-8f860ba10615",
        "leaveType-88681ca1-4a47-4e4d-bc35-ffff86c0f54e"
      ],
      "startDate": "2026-05-11",
      "endDate": "2026-05-15",
      "recurring": false,
      "reason": ""
    }
  ]
}

{
  "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"
  }
}

Authorization

Path Parameters

Response Body

200application/json

401application/json

403application/json

404application/json

429application/json

500application/json

Key lacks a required scope

Key was revoked

Acting user may not perform the action

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`