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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.filter | string | Optional | |
query.expand | string | Optional | |
query.order_by | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
__meta | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List leave requests — response body — results item |
Referenced models: List leave requests — response body — results item, List Sites — response body — meta
Schemas
Section titled “Schemas”25 more schemas are linked from the tables above, on the schema pages.
List leave requests — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comments | string | Optional | The comments associated with the leave request. |
created_at | string | Required within parent | Record creation date |
days_take_off | array | Optional | The specific dates taken off and the amount of time taken off for each one. |
days_take_off[] | Model | Each item | Expand Update a leave request — response body — days take off item |
end_date | string | Required within parent | The end date of the leave request. |
end_time | string | Optional | The end time of the leave request. |
id | string | Required within parent | Identifier field |
is_managed_by_external_system | boolean | Optional | Whether the leave request is managed by an external system. |
leave_event_id | string | Optional | The ID of the leave event associated with the leave request, if any. |
leave_policy_id | string | Optional | The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided. |
leave_type | Model | Optional | Expand Update a leave request — response body — leave type |
leave_type_id | string | Optional | The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided. |
number_of_minutes_requested | JSON | Optional | |
number_of_minutes_requested (anyOf 1) | number | Alternative | The number of minutes requested for the leave request. |
number_of_minutes_requested (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reason_for_leave | string | Optional | The reason for the leave request. |
requester | Model | Optional | Expand Update a leave request — response body — requester |
requester_id | string | Optional | The ID of the worker who requested the leave request. |
reviewed_at | string | Optional | The timestamp of when the leave request was reviewed. |
reviewer | Model | Optional | Expand Update a leave request — response body — reviewer |
reviewer_id | string | Optional | The ID of the worker who reviewed the leave request. |
start_date | string | Required within parent | The start date of the leave request. |
start_time | string | Optional | The start time of the leave request. |
status | string | Required within parent | The status of the leave request. Known values: PENDING, APPROVED, REJECTED, CANCELED |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a leave request — response body — worker |
worker_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
Update a leave request — response body — days take off item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | string | Required within parent | The date of the day off. |
number_of_minutes_taken_off | JSON | Required within parent | |
number_of_minutes_taken_off (anyOf 1) | number | Alternative | The number of minutes taken off for the day. |
number_of_minutes_taken_off (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a leave request — response body — leave type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The leave type associated with the leave request. Expandable field |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the leave type. |
id | string | Required within parent | Identifier field |
is_managed_by_external_system | boolean | Required within parent | Whether the leave is managed by an external system. |
is_paid | boolean | Required within parent | Whether the leave is paid. |
name | string | Required within parent | The name of the leave type. |
type | string | Required within parent | The type of leave. |
updated_at | string | Required within parent | Record update date |
Retrieve a specific worker — response body — business partners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | object | Optional | Business partner group the business partner is a part of Expandable field |
business_partner_group.created_at | string | Required within parent | Record creation date |
business_partner_group.default_business_partner | Model | Optional | Expand 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_id | string | Optional | Id 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.domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
business_partner_group.id | string | Required within parent | Identifier field |
business_partner_group.name | string | Required within parent | Name used to identify business partner group |
business_partner_group.updated_at | string | Required within parent | Record update date |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (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 |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific worker — response body — manager Worker who is the business partner Expandable field |
worker_id | string | Required within parent | Identifier 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the team. |
parent | Model | Optional | Expand Update a team — response body — parent The parent team Expandable field |
parent_id | string | Optional | The parent team |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a team — response body — parent
Retrieve a specific worker — response body — work schedule value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled working hours for a day of the week. |
hours | JSON | Optional | |
hours (anyOf 1) | number | Alternative | The number of scheduled working hours for the day. |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific user — response body — emails item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display | string | Optional | The display value of the email address. |
type | string | Optional | The classification of the email. Known values: HOME, WORK, OTHER |
value | string | Optional | A valid email address. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}