Skip to content

Rippling: GET Leave Requests — response body — item

GET Leave Requests: response body, field item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: GET Leave Requests — response body — item

FieldTypePresenceDescription and constraints
$objectRootLeave request object.
commentsJSONOptional
comments (anyOf 1)stringAlternative
comments (anyOf 2)nullAlternative
createdAtstringOptional
datesarrayOptional
dates[]objectEach item
dates[].datestringOptionalFormat: date
dates[].numMinutesJSONOptional
dates[].numMinutes (anyOf 1)integerAlternative
dates[].numMinutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDatestringOptional
endDateCustomHoursJSONOptional
endDateCustomHours (anyOf 1)JSONAlternative
endDateCustomHours (anyOf 1) (anyOf 1)stringAlternative
endDateCustomHours (anyOf 1) (anyOf 2)nullAlternative
endDateCustomHours (anyOf 2)JSONAlternative
endDateCustomHours (anyOf 2) (anyOf 1)numberAlternative
endDateCustomHours (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDateEndTimeJSONOptional
endDateEndTime (anyOf 1)stringAlternative
endDateEndTime (anyOf 2)nullAlternative
idstringOptionalUnique identifier of the leave request.
isPaidbooleanOptionalIf the leave request is paid this will be TRUE. Otherwise, this will be FALSE.
leavePolicystringOptional
leaveTypeUniqueIdstringOptionalKnown values: VACATION, SICK, JURY_DUTY
managedBystringOptionalThis indicates the system that manages the Leave Request. PTO = managed by Rippling’s Time Off app. LEAVES = managed by Rippling’s Leave Management app. TILT = managed by third-party partner Tilt.
Known values: PTO, LEAVES, TILT
numHoursJSONOptional
numHours (anyOf 1)JSONAlternative
numHours (anyOf 1) (anyOf 1)integerAlternative
numHours (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numHours (anyOf 2)nullAlternative
numMinutesJSONOptional
numMinutes (anyOf 1)JSONAlternative
numMinutes (anyOf 1) (anyOf 1)integerAlternative
numMinutes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numMinutes (anyOf 2)nullAlternative
partialDaysarrayOptional
partialDays[]JSONEach item
partialDays[] (anyOf 1)objectAlternative
partialDays[] (anyOf 1).numMinutesJSONOptional
partialDays[] (anyOf 1).numMinutes (anyOf 1)integerAlternative
partialDays[] (anyOf 1).numMinutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
partialDays[] (anyOf 1).partialDaystringOptionalFormat: date
partialDays[] (anyOf 2)nullAlternative
policyDisplayNamestringOptional
processedAtJSONOptional
processedAt (anyOf 1)stringAlternative
processedAt (anyOf 2)nullAlternative
processedByJSONOptional
processedBy (anyOf 1)stringAlternativeUnique identifier of the employee who approved or rejected the request. This may be null.
processedBy (anyOf 2)nullAlternative
processedByNameJSONOptional
processedByName (anyOf 1)stringAlternative
processedByName (anyOf 2)nullAlternative
reasonForLeaveJSONOptional
reasonForLeave (anyOf 1)stringAlternative
reasonForLeave (anyOf 2)nullAlternative
requestedByJSONOptional
requestedBy (anyOf 1)stringAlternative
requestedBy (anyOf 2)nullAlternative
requestedByNameJSONOptional
requestedByName (anyOf 1)stringAlternativeUnique identifier of the employee who made the request (in most cases this is the same as role).
requestedByName (anyOf 2)nullAlternative
rolestringOptionalUnique identifier of the employee who is taking leave.
roleNamestringOptional
roleTimezoneJSONOptional
roleTimezone (anyOf 1)stringAlternativeTimezone of the role. This will be work location timezone, or home timezone for employees without a work location.
roleTimezone (anyOf 2)nullAlternative
startDatestringOptional
startDateCustomHoursJSONOptional
startDateCustomHours (anyOf 1)JSONAlternative
startDateCustomHours (anyOf 1) (anyOf 1)stringAlternative
startDateCustomHours (anyOf 1) (anyOf 2)nullAlternative
startDateCustomHours (anyOf 2)JSONAlternative
startDateCustomHours (anyOf 2) (anyOf 1)numberAlternative
startDateCustomHours (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDateStartTimeJSONOptional
startDateStartTime (anyOf 1)stringAlternative
startDateStartTime (anyOf 2)nullAlternative
statusstringOptionalKnown values: PENDING, APPROVED, REJECTED, CANCELED
updatedAtstringOptional

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.