Rippling: POST Leave Request
Rippling baseApi.postLeaveRequests: arguments, response, policy and SDK examples.
← Base API operations · Get started
Operation rippling.base_api.post_leave_requests
Provider route: POST /platform/api/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["baseApi"]["postLeaveRequests"]>[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.baseApi.postLeaveRequests(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.base_api.post_leave_requests(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.companyLeaveType | string | Required within parent | Unique identifier of the company leave type |
body.endDate | string | Required within parent | |
body.endDateCustomHours | string | Optional | |
body.endDateEndTime | string | Optional | |
body.externalId | string | Optional | Object id for corresponding leave obejct in third party system. This may be null. |
body.leavePolicy | string | Required within parent | Unique identifier of the leave policy. Required if request is not managed by TILT |
body.managedBy | string | Optional | String identifier for third party that manages this leave request. This may be null. |
body.reasonForLeave | string | Optional | |
body.requestedBy | string | Optional | |
body.role | string | Required within parent | Unique identifier of the employee who is taking leave. |
body.startDate | string | Required within parent | |
body.startDateCustomHours | string | Optional | |
body.startDateStartTime | string | Optional | |
body.status | string | Optional | The status to create the leave request in. Only TILT managed requests can take a status other than PENDING. |
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 |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand GET Leave Requests — response body — item |
$ (anyOf 2) | array | Alternative | |
$ (anyOf 2)[] | Model | Each item | Expand GET Leave Requests — response body — item |
Referenced models: GET Leave Requests — response body — item
Schemas
Section titled “Schemas”GET Leave Requests — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Leave request object. |
comments | JSON | Optional | |
comments (anyOf 1) | string | Alternative | |
comments (anyOf 2) | null | Alternative | |
createdAt | string | Optional | |
dates | array | Optional | |
dates[] | object | Each item | |
dates[].date | string | Optional | Format: date |
dates[].numMinutes | JSON | Optional | |
dates[].numMinutes (anyOf 1) | integer | Alternative | |
dates[].numMinutes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
endDate | string | Optional | |
endDateCustomHours | JSON | Optional | |
endDateCustomHours (anyOf 1) | JSON | Alternative | |
endDateCustomHours (anyOf 1) (anyOf 1) | string | Alternative | |
endDateCustomHours (anyOf 1) (anyOf 2) | null | Alternative | |
endDateCustomHours (anyOf 2) | JSON | Alternative | |
endDateCustomHours (anyOf 2) (anyOf 1) | number | Alternative | |
endDateCustomHours (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
endDateEndTime | JSON | Optional | |
endDateEndTime (anyOf 1) | string | Alternative | |
endDateEndTime (anyOf 2) | null | Alternative | |
id | string | Optional | Unique identifier of the leave request. |
isPaid | boolean | Optional | If the leave request is paid this will be TRUE. Otherwise, this will be FALSE. |
leavePolicy | string | Optional | |
leaveTypeUniqueId | string | Optional | Known values: VACATION, SICK, JURY_DUTY |
managedBy | string | Optional | This 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 |
numHours | JSON | Optional | |
numHours (anyOf 1) | JSON | Alternative | |
numHours (anyOf 1) (anyOf 1) | integer | Alternative | |
numHours (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
numHours (anyOf 2) | null | Alternative | |
numMinutes | JSON | Optional | |
numMinutes (anyOf 1) | JSON | Alternative | |
numMinutes (anyOf 1) (anyOf 1) | integer | Alternative | |
numMinutes (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
numMinutes (anyOf 2) | null | Alternative | |
partialDays | array | Optional | |
partialDays[] | JSON | Each item | |
partialDays[] (anyOf 1) | object | Alternative | |
partialDays[] (anyOf 1).numMinutes | JSON | Optional | |
partialDays[] (anyOf 1).numMinutes (anyOf 1) | integer | Alternative | |
partialDays[] (anyOf 1).numMinutes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
partialDays[] (anyOf 1).partialDay | string | Optional | Format: date |
partialDays[] (anyOf 2) | null | Alternative | |
policyDisplayName | string | Optional | |
processedAt | JSON | Optional | |
processedAt (anyOf 1) | string | Alternative | |
processedAt (anyOf 2) | null | Alternative | |
processedBy | JSON | Optional | |
processedBy (anyOf 1) | string | Alternative | Unique identifier of the employee who approved or rejected the request. This may be null. |
processedBy (anyOf 2) | null | Alternative | |
processedByName | JSON | Optional | |
processedByName (anyOf 1) | string | Alternative | |
processedByName (anyOf 2) | null | Alternative | |
reasonForLeave | JSON | Optional | |
reasonForLeave (anyOf 1) | string | Alternative | |
reasonForLeave (anyOf 2) | null | Alternative | |
requestedBy | JSON | Optional | |
requestedBy (anyOf 1) | string | Alternative | |
requestedBy (anyOf 2) | null | Alternative | |
requestedByName | JSON | Optional | |
requestedByName (anyOf 1) | string | Alternative | Unique identifier of the employee who made the request (in most cases this is the same as role). |
requestedByName (anyOf 2) | null | Alternative | |
role | string | Optional | Unique identifier of the employee who is taking leave. |
roleName | string | Optional | |
roleTimezone | JSON | Optional | |
roleTimezone (anyOf 1) | string | Alternative | Timezone of the role. This will be work location timezone, or home timezone for employees without a work location. |
roleTimezone (anyOf 2) | null | Alternative | |
startDate | string | Optional | |
startDateCustomHours | JSON | Optional | |
startDateCustomHours (anyOf 1) | JSON | Alternative | |
startDateCustomHours (anyOf 1) (anyOf 1) | string | Alternative | |
startDateCustomHours (anyOf 1) (anyOf 2) | null | Alternative | |
startDateCustomHours (anyOf 2) | JSON | Alternative | |
startDateCustomHours (anyOf 2) (anyOf 1) | number | Alternative | |
startDateCustomHours (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startDateStartTime | JSON | Optional | |
startDateStartTime (anyOf 1) | string | Alternative | |
startDateStartTime (anyOf 2) | null | Alternative | |
status | string | Optional | Known values: PENDING, APPROVED, REJECTED, CANCELED |
updatedAt | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.base_api.post_leave_requests. Catalog operation: v1.post-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.