Rippling: List leave balances — response body — results item
List leave balances: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: List leave balances — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balance_excluding_future_requests | JSON | Optional | |
balance_excluding_future_requests (anyOf 1) | number | Alternative | The worker’s leave balance excluding future leave requests. If the leave balance is unlimited, this field will be null. |
balance_excluding_future_requests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_excluding_future_requests_in_days | JSON | Optional | |
balance_excluding_future_requests_in_days (anyOf 1) | number | Alternative | The worker’s leave balance in days excluding future leave requests. If the leave balance is unlimited, this field will be null. |
balance_excluding_future_requests_in_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_including_future_requests | JSON | Optional | |
balance_including_future_requests (anyOf 1) | number | Alternative | The worker’s leave balance including future leave requests. If the leave balance is unlimited, this field will be null. |
balance_including_future_requests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_including_future_requests_in_days | JSON | Optional | |
balance_including_future_requests_in_days (anyOf 1) | number | Alternative | The worker’s leave balance in days including future leave requests. If the leave balance is unlimited, this field will be null. |
balance_including_future_requests_in_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_balance_unlimited | boolean | Optional | Indicates if the leave balance is unlimited. |
leave_type | Model | Optional | Expand Retrieve a specific leave balance — response body — leave type |
leave_type_id | string | Optional | The ID of the leave type associated with the leave balance. |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific leave balance — response body — worker |
worker_id | string | Required within parent | The ID of the worker associated with the leave balance. |
Referenced models: Retrieve a specific leave balance — response body — leave type, Retrieve a specific leave balance — response body — worker