get https://{subdomain}.workable.com/spi/v3/timeoff/balances
Returns a collection of your time off balances concerning all time off categories. Required scope: r_timeoff.
Log in to see full request history
| time | status | user agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This particular endpoint uses
r_timeoffscope, which can be enabled through the Integrations section found within the Settings menu. Account level tokens needemployee_idas query parameter to work.
Results
Calling the /timeoff/balances endpoint will return a collection of all time off balances for a specific employee for the current cycle. An example of the response follows:
{
"balances": [
{
"units_available": "13.00",
"units_carry_over_available": "0.00",
"units_used": "0.00",
"has_unlimited_timeoff": false,
"category_id": "76f",
"time_off_tracking_unit": "full_days",
"name": "Sick leave",
"description": "For paid time away from work due to illness or sickness."
},
{
"units_available": "1.62",
"units_carry_over_available": "0.00",
"units_used": "0.00",
"has_unlimited_timeoff": false,
"category_id": "76e",
"time_off_tracking_unit": "half_days",
"name": "Paid time off ",
"description": "For vacations, holidays and other paid time away from work."
}
]
}
Each timeoff balance will have the following keys:
| key | type | description |
|---|---|---|
| units_available | string | A string representation of the available units for the specific time off category |
| units_carry_over_available | string | A string representation of the available units derived from a previous time off cycle |
| units_used | string | A string representation of the units used during the current cycle |
| has_unlimited_timeoff | boolean | A boolean representation weather the category refers to an unlimited time off category |
| category_id | string | The uid of the time off category |
| time_off_tracking_unit | integer | Time off tracking unit, half_days or full_days are the valid options |
| description | string | A description of the time off category implied by the time off balance |
Responses