---
title: "Return a list of time-off statuses."
method: GET
path: "/time-off/status"
tags: ["Time off"]
---

# Return a list of time-off statuses.

`GET /time-off/status`

This endpoint returns an object with the balance details for a given time-off type and user.

## Query parameters

- `_userId` string, required
- `_timeOffTypeId` string, required

## Headers

- `Authorization` string, required

## Response `200`

OK.

- object
  - `_userId` string — The Kenjo employee *_id*.
  - `_timeOffTypeId` string — The Kenjo *time-off type Id* of one existing time-off type.
  - `timeOffTypeName` string — The Kenjo *time-off type Name* for an existing time-off type.
  - `policyName` string — The name of the policy id associated to the time-off request.
  - `_policyType` 'Day' | 'Hour' — Indicates if the policy type is in days or hours.
  - `unlimitedAllowance` boolean — True if the policy is unlimited. If the policy is set to unlimited the fields totalAllowance, cycleAllowance, prevCycleCarryOver, available, carryOverEnabled, plannedFromCarryOver, takenFromCarryOver, expiredCarryOver and carryOverExpiresAt will not be returned in the response object
  - `totalAllowance` number — Total allowance for the current time-off cycle. If the policy is set to unlimited, this field will not be returned. Any manual adjustments to the total allowance will be reflected in this result.
  - `cycleAllowance` number — Total amount granted in the time-off policy configuration. If the policy is set to unlimited, this field will not be returned. Any manual adjustments to the cycle allowance will be reflected in this result.
  - `prevCycleCarryOver` number — Total amount carried over from the previous cycle. If the policy is set to unlimited, this field will not be returned. Any manual adjustments to the carry over coming from the previous cycle will be reflected in this result.
  - `alreadyTaken` number — Amount of days or hours already taken, this will include days taken from carryover. Any manual adjustments to the taken days or hours will be reflected in this result.
  - `planned` number — Amount of days or hours planned.
  - `available` number — Total amount available to request. If the policy is set to unlimited, this field will not be returned.
  - `carryOverEnabled` boolean — Indicates if the policy allows carryover or not. If the policy is set to unlimited, this field will not be returned.
  - `plannedFromCarryOver` number — Amount of days or hours planned from the carryover. If the policy is set to unlimited, this field will not be returned.
  - `takenFromCarryOver` number — Amount of days or hours taken from the carryover. If the policy is set to unlimited, this field will not be returned.
  - `expiredCarryOver` number — Total amount of carry over that has expired. If the policy is set to unlimited, this field will not be returned.
  - `carryOverExpiresAt` string — Date when the carryover from the previous cycle expires. In format YYYY-MM-DDThh:mm:ss. If the policy is set to unlimited, this field will not be returned.

## Other responses

- `400` — BAD REQUEST. This is a wrong request in the client side due to invalid body or params.
- `401` — UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

---

[API](https://skmtc.net/kenjo/apis/kenjo-api.md) · [All operations](https://skmtc.net/kenjo/apis/kenjo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kenjo/kenjo-api/revisions/58772b78268e/schema)