Rippling: GET Leave Balance — response body — balances Leave balances object
GET Leave Balance: response body, field balances / Leave balances object. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: GET Leave Balance — response body — balances Leave balances object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Leave balances object |
| string | Optional | |
balanceWithFutureRequests | JSON | Optional | |
balanceWithFutureRequests (anyOf 1) | number | Alternative | The remaining balance in minutes for the employee corresponding to the company leave type with future leave requests considered. |
balanceWithFutureRequests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balanceWithoutFutureRequests | JSON | Optional | |
balanceWithoutFutureRequests (anyOf 1) | number | Alternative | The remaining balance in minutes for the employee corresponding to the company leave type with future leave requests not considered. |
balanceWithoutFutureRequests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
companyLeaveType | string | Optional | This is the unique role ID of the company leave types. Corresponds to the ids in response of GET Company Leave Types |
isBalanceUnlimited | boolean | Optional | true if employee’s balance corresponding to the company leave type is unlimited, else false |