Skip to content

Rippling: Retrieve a specific leave balance — response body — leave type

Retrieve a specific leave balance: response body, field leave_type. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Retrieve a specific leave balance — response body — leave type

FieldTypePresenceDescription and constraints
$objectRootThe leave type associated with the leave balance.

Expandable field
created_atstringRequired within parentRecord creation date
descriptionstringOptionalThe description of the leave type.
idstringRequired within parentIdentifier field
is_managed_by_external_systembooleanRequired within parentWhether the leave is managed by an external system.
is_paidbooleanRequired within parentWhether the leave is paid.
namestringRequired within parentThe name of the leave type.
typestringRequired within parentThe type of leave.
updated_atstringRequired within parentRecord update date

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.