Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Time off

Return a list of time-off statuses.

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

get/time-off/status

Query parameters

_userIdstring required
Example:60a2db290da29e126a18789b

A _userId is required to retrieve the time-off statuses.

_timeOffTypeIdstring required
Example:60a2db290da29e126a18789c

A _timeOffTypeId is required to retrieve the time-off statuses.

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK.

_userIdstring

The Kenjo employee _id.

_timeOffTypeIdstring

The Kenjo time-off type Id of one existing time-off type.

timeOffTypeNamestring

The Kenjo time-off type Name for an existing time-off type.

policyNamestring

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.

unlimitedAllowanceboolean

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

totalAllowancenumber

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.

cycleAllowancenumber

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.

prevCycleCarryOvernumber

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.

alreadyTakennumber

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.

plannednumber

Amount of days or hours planned.

availablenumber

Total amount available to request. If the policy is set to unlimited, this field will not be returned.

carryOverEnabledboolean

Indicates if the policy allows carryover or not. If the policy is set to unlimited, this field will not be returned.

plannedFromCarryOvernumber

Amount of days or hours planned from the carryover. If the policy is set to unlimited, this field will not be returned.

takenFromCarryOvernumber

Amount of days or hours taken from the carryover. If the policy is set to unlimited, this field will not be returned.

expiredCarryOvernumber

Total amount of carry over that has expired. If the policy is set to unlimited, this field will not be returned.

carryOverExpiresAtstring

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.

Example response

{
  "_userId": "50a2db290da29e126a18789a",
  "_timeOffTypeId": "50a2db290da29e126a18789f",
  "timeOffTypeName": "Holidays",
  "policyName": "Holidays 24 days",
  "totalAllowance": 24,
  "cycleAllowance": 21,
  "prevCycleCarryOver": 3,
  "alreadyTaken": 5,
  "planned": 9,
  "available": 10,
  "carryOverEnabled": true,
  "takenFromCarryOver": 3,
  "carryOverExpiresAt": "2024-03-31T00:00:00"
}