Skip to content

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.

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 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.base_api.post_leave_requests(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.companyLeaveTypestringRequired within parentUnique identifier of the company leave type
body.endDatestringRequired within parent
body.endDateCustomHoursstringOptional
body.endDateEndTimestringOptional
body.externalIdstringOptionalObject id for corresponding leave obejct in third party system. This may be null.
body.leavePolicystringRequired within parentUnique identifier of the leave policy. Required if request is not managed by TILT
body.managedBystringOptionalString identifier for third party that manages this leave request. This may be null.
body.reasonForLeavestringOptional
body.requestedBystringOptional
body.rolestringRequired within parentUnique identifier of the employee who is taking leave.
body.startDatestringRequired within parent
body.startDateCustomHoursstringOptional
body.startDateStartTimestringOptional
body.statusstringOptionalThe status to create the leave request in. Only TILT managed requests can take a status other than PENDING.

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand GET Leave Requests — response body — item
$ (anyOf 2)arrayAlternative
$ (anyOf 2)[]ModelEach itemExpand GET Leave Requests — response body — item

Referenced models: GET Leave Requests — response body — item

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

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.

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.