Vacation Tracker Docs
REST API v2API referenceLabels

Get a label

This API method returns a single label. Requires `labels:read`. Errors: `404 RESOURCE_NOT_FOUND` (the label does not exist).

GET
/v2/labels/{id}

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/labels/string"
{
  "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

Create a label

This API method creates a label. Requires `labels:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the label to be created and returns it with `201`, or `202 Accepted` with an operation to poll. `name` and `color` are required, non-empty strings; unknown fields fail validation. Assign the label to users with `POST /v2/users/{id}/labels`. Errors: `400 VALIDATION_ERROR` (`details.fields`), `400 INVALID_REQUEST_BODY`, `403 ON_BEHALF_OF_NOT_ALLOWED`, `403 FORBIDDEN`, `422 PLAN_LIMIT_REACHED`, and the `Idempotency-Key` codes.

Update a label

This API method changes a label. Requires `labels:write`. The acting user is the key owner, or the `X-On-Behalf-Of` user. It waits for the change and returns the label with `200`, or `202 Accepted` with an operation to poll. Send only the fields you want to change; at least one field is required. The field you do not send keeps its current value. Errors: `400 VALIDATION_ERROR` (`details.fields`), `400 INVALID_REQUEST_BODY`, `403 ON_BEHALF_OF_NOT_ALLOWED`, `403 FORBIDDEN`, `404 RESOURCE_NOT_FOUND` (the label does not exist), and the `Idempotency-Key` codes.