Vacation Tracker Docs
REST API v2API referenceLocations

Get a location's work week

This API method returns the working days and work hours of a location. Requires `locations:read`. `workHours` lists only the days with custom work hours and is left out when there are none. Errors: `404 RESOURCE_NOT_FOUND` (the location does not exist or is outside the key's data reach, or it has no stored work week yet).

GET
/v2/locations/{id}/work-week

Authorization

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

Path Parameters

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/locations/string/work-week"
{
  "data": {
    "days": [
      1,
      2,
      3,
      4,
      5
    ],
    "workHours": [
      {
        "day": 5,
        "hours": 4
      }
    ]
  }
}
{
  "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

Delete a location

This API method deletes a location. Requires `locations:write`. No request body. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the deletion and returns `204`, or `202 Accepted` with an operation to poll. The company's default location can never be deleted: make another location the default first. Deleting any other location moves all of its users to the default location and deletes the location's holidays. Errors: `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 DEFAULT_LOCATION_DELETE_FORBIDDEN`, and the `Idempotency-Key` codes.

Replace a location's work week

This API method replaces the working days and work hours of a location. Requires `locations:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the change and returns the new work week with `200`, or `202 Accepted` with an operation to poll. - This is a full replacement, not a merge: send every working day in `days`, and every custom work-hours entry in `workHours`. Days without a `workHours` entry use the default work hours. - `resetUserOverrides` defaults to `false`. Set it to `true` to also clear every per-user work week override in this location, so every user follows the new work week. Errors: `400 VALIDATION_ERROR` (`details.fields`), `400 INVALID_REQUEST_BODY`, `403 ON_BEHALF_OF_NOT_ALLOWED`, `403 FORBIDDEN`, `403 WORK_HOURS_LIMIT_REACHED` (custom work hours need a plan that includes them), `404 RESOURCE_NOT_FOUND` (the location does not exist or is outside the key's data reach), and the `Idempotency-Key` codes.