Skip to content

Rippling: List leave requests

Rippling restApi.listLeaveRequests: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_leave_requests

Provider route: GET /leave-requests/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listLeaveRequests"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.listLeaveRequests(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.list_leave_requests(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List leave requests — response body — results item

Referenced models: List leave requests — response body — results item, List Sites — response body — meta

25 more schemas are linked from the tables above, on the schema pages.

List leave requests — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
commentsstringOptionalThe comments associated with the leave request.
created_atstringRequired within parentRecord creation date
days_take_offarrayOptionalThe specific dates taken off and the amount of time taken off for each one.
days_take_off[]ModelEach itemExpand Update a leave request — response body — days take off item
end_datestringRequired within parentThe end date of the leave request.
end_timestringOptionalThe end time of the leave request.
idstringRequired within parentIdentifier field
is_managed_by_external_systembooleanOptionalWhether the leave request is managed by an external system.
leave_event_idstringOptionalThe ID of the leave event associated with the leave request, if any.
leave_policy_idstringOptionalThe ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.
leave_typeModelOptionalExpand Update a leave request — response body — leave type
leave_type_idstringOptionalThe ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.
number_of_minutes_requestedJSONOptional
number_of_minutes_requested (anyOf 1)numberAlternativeThe number of minutes requested for the leave request.
number_of_minutes_requested (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reason_for_leavestringOptionalThe reason for the leave request.
requesterModelOptionalExpand Update a leave request — response body — requester
requester_idstringOptionalThe ID of the worker who requested the leave request.
reviewed_atstringOptionalThe timestamp of when the leave request was reviewed.
reviewerModelOptionalExpand Update a leave request — response body — reviewer
reviewer_idstringOptionalThe ID of the worker who reviewed the leave request.
start_datestringRequired within parentThe start date of the leave request.
start_timestringOptionalThe start time of the leave request.
statusstringRequired within parentThe status of the leave request.
Known values: PENDING, APPROVED, REJECTED, CANCELED
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Update a leave request — response body — worker
worker_idstringRequired within parentThe ID of the worker associated with the leave request.

Referenced models: Update a leave request — response body — days take off item, Update a leave request — response body — leave type, Update a leave request — response body — requester, Update a leave request — response body — reviewer, Update a leave request — response body — worker

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
Update a leave request — response body — days take off item
FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentThe date of the day off.
number_of_minutes_taken_offJSONRequired within parent
number_of_minutes_taken_off (anyOf 1)numberAlternativeThe number of minutes taken off for the day.
number_of_minutes_taken_off (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Update a leave request — response body — leave type
FieldTypePresenceDescription and constraints
$objectRootThe leave type associated with the leave request.

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
Retrieve a specific worker — response body — business partners item
FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

Update a team — response body — parent
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the team.
parentModelOptionalExpand Update a team — response body — parent
The parent team

Expandable field
parent_idstringOptionalThe parent team
updated_atstringRequired within parentRecord update date

Referenced models: Update a team — response body — parent

Retrieve a specific worker — response body — work schedule value
FieldTypePresenceDescription and constraints
$objectRootThe scheduled working hours for a day of the week.
hoursJSONOptional
hours (anyOf 1)numberAlternativeThe number of scheduled working hours for the day.
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve a specific user — response body — emails item
FieldTypePresenceDescription and constraints
$objectRoot
displaystringOptionalThe display value of the email address.
typestringOptionalThe classification of the email.
Known values: HOME, WORK, OTHER
valuestringOptionalA valid email address.

SDK function policy ID: rippling.rest_api.list_leave_requests. Catalog operation: list-leave-requests. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["leave-requests.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

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.