Vacation TrackerDeveloper Docs
REST API v2API referenceLeave types

Get a leave type

This API method returns a single leave type. Requires leave-types:read.

Errors: 404 RESOURCE_NOT_FOUND (the leave type does not exist or was deleted).

GET
/v2/leave-types/{id}

Authorization

bearerAuth leave-types: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: leave-types: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/leave-types/string"
{
  "data": {
    "id": "leaveType-fcc1e5c5-ba93-479d-bd58-8f860ba10615",
    "name": "Vacation",
    "isActive": true,
    "color": "#1E90FF",
    "position": 0,
    "calendarStatus": "Busy"
  }
}
{
  "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 leave type

This API method creates a leave type and can enable it in locations right away. Requires leave-types:write. The acting user is the key owner, or the X-On-Behalf-Of user. It waits for the leave type to be created and returns it with 201, or 202 Accepted with an operation to poll.

Update a leave type

This API method changes a leave type. Requires leave-types:write. The acting user is the key owner, or the X-On-Behalf-Of user. It waits for the change and returns the leave type with 200, or 202 Accepted with an operation to poll.