WOworkable

/timeoff/balances

Returns a collection of your time off balances concerning all time off categories. Required scope: r_timeoff.

get/timeoff/balances

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/timeoff/balances
  • Auth
    API key in header Authorization

Query parameters

employee_idstring

The employee to retrieve time off requests for. Required for account tokens. Optional for user tokens — when omitted, defaults to the authenticated user's employee.

Response

200

Example response

{
  "balances": [
    {
      "units_available": "13.00",
      "units_carry_over_available": "0.00",
      "units_used": "0.00",
      "category_id": "76f",
      "time_off_tracking_unit": "full_days",
      "name": "Sick leave",
      "description": "For paid time away from work due to illness or sickness."
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.