Vacation Tracker Docs
REST API v2API referenceUsers

List a user's labels

This API method returns the labels assigned to a user. Requires `labels:read`. Labels are company-wide, so this works for any user of the company, whatever the key's data reach. The list is not paginated. Errors: `404 RESOURCE_NOT_FOUND` (the user does not exist).

GET
/v2/users/{id}/labels

Authorization

bearerAuth labels: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: labels: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/users/string/labels"
{
  "data": [
    {
      "id": "969f8429-7dc3-48a1-96b1-6049a99dda06",
      "name": "contractor",
      "color": "#FF0000",
      "userCount": 12
    }
  ]
}
{
  "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

Get a user's leave balances

This API method returns the leave balances of a user, calculated the same way as in the Vacation Tracker dashboard, one entry per leave year. Requires `balances:read`. The list is not paginated. - Only active leave types are included, in the order shown in the dashboard. - A key without `leave-types:read-hidden` gets `Hidden Leave Type` as `leaveTypeName` for leave types hidden by the policy of the user's location. `leaveTypeId` and every amount are unchanged. - For leave types with unlimited days, `baseQuota`, `earned`, `quotaAtYearEnd` and `remaining` are null. - `period=current` returns the leave year that contains today, or the latest leave year when none does; `isCurrent` tells which one it is. Errors: `400 VALIDATION_ERROR` (an invalid `period`) and `404 RESOURCE_NOT_FOUND` (the user does not exist or is outside the key's data reach).

Assign a label to a user

This API method assigns a label to a user. Requires `labels:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the assignment and returns the user's full list of labels with `200`, or `202 Accepted` with an operation to poll. Errors: `400 VALIDATION_ERROR` (`labelId` missing or invalid), `403 ON_BEHALF_OF_NOT_ALLOWED`, `403 FORBIDDEN`, `404 RESOURCE_NOT_FOUND` (the user or the label does not exist), and the `Idempotency-Key` codes.