Vacation TrackerDeveloper Docs
REST API v2API referenceUsers

Get a user

This API method returns a single user. Requires users:read. Each expand value needs the read scope of the resource it embeds: location needs locations:read, department needs departments:read, holidays needs holidays:read. Without it the request fails with 403 INSUFFICIENT_SCOPE, and details.expand names the values that asked for it.

Errors: 400 VALIDATION_ERROR (an unknown expand value), 403 INSUFFICIENT_SCOPE (an expand value whose read scope the key does not have) and 404 RESOURCE_NOT_FOUND (the user does not exist or is outside the key's data reach).

GET
/v2/users/{id}

Authorization

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

Path Parameters

id*string

resource ID.

Query Parameters

expand?array<>

a comma-separated list of related resources to include in each user. Options: location (the user's location, requires locations:read), department (the user's department, requires departments:read) and holidays (public holidays for the user's location grouped by year, requires holidays:read). Each value needs the read scope of the resource it embeds.

Value in"location" | "department" | "holidays"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/users/string?expand=location%2Cdepartment"
{
  "data": {
    "id": "user-cfe5d39b-f1f0-45aa-85cd-ce93e637a262",
    "name": "John Chao",
    "email": "johnchao@chaochao.com",
    "isAdmin": false,
    "locationId": "location-79c77ac8-e5bf-479f-9488-648a58379ff1",
    "departmentId": "team-0a21c25e-6925-4a5b-90ee-ecf82096c4f6",
    "status": "ACTIVE",
    "employeeId": "E-1024",
    "startDate": "2022-11-08",
    "endDate": null,
    "labels": [
      {
        "id": "969f8429-7dc3-48a1-96b1-6049a99dda06",
        "name": "contractor",
        "color": "#FF0000"
      }
    ]
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "name": "ValidationError",
    "description": "A query parameter, body field or header failed validation.",
    "resolution": "Fix the fields listed in details.fields and send the request again.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
    "details": {
      "fields": [
        {
          "path": "startDate",
          "message": "\"startDate\" is required"
        }
      ]
    }
  }
}
{
  "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

List users

This API method returns a paginated list of users within the key's data reach, with their IDs, names, and basic info. Requires users:read. Each user has the same shape as in API v1.

Update a user's profile

This API method changes a user's profile. Requires users:write. It waits for the change and returns the user with 200, or 202 Accepted with an operation to poll.