Skip to content

Rippling: GET Company Payroll Runs

Rippling payrollApi.getPayrollRuns: arguments, response, policy and SDK examples.

← Payroll API operations · Get started

Operation rippling.payroll_api.get_payroll_runs

Provider route: GET /platform/api/payroll_runs. 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["payrollApi"]["getPayrollRuns"]>[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.payrollApi.getPayrollRuns(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.payroll_api.get_payroll_runs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.einintegerOptional
query.limitintegerOptional
query.offsetintegerOptional

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

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand GET Company Payroll Runs — response body — item

Referenced models: GET Company Payroll Runs — response body — item

GET Company Payroll Runs — response body — item
FieldTypePresenceDescription and constraints
$objectRootThe payroll run object.
approvalDeadlinestringOptional
approvedAtJSONOptional
approvedAt (anyOf 1)stringAlternative
approvedAt (anyOf 2)nullAlternative
checkDatestringOptional
einstringOptionalEmployer identification number, also known as the Federal Employer Identification Number or the Federal Tax Identification Number.
idstringOptionalThe unique identifier for the payroll run.
namestringOptional
payPeriodJSONOptional
payPeriod (anyOf 1)objectAlternative
payPeriod (anyOf 1).endDatestringOptional
payPeriod (anyOf 1).payScheduleJSONOptional
payPeriod (anyOf 1).paySchedule (anyOf 1)stringAlternative
payPeriod (anyOf 1).paySchedule (anyOf 2)nullAlternative
payPeriod (anyOf 1).startDatestringOptional
payPeriod (anyOf 2)nullAlternative
runStatestringOptionalDRAFT means the admin hasn't approved the run yet.
APPROVED means the admin has approved the run, but the check date has not arrived yet.
PAID means the check date has arrived and the run was paid.
FAILED means the check date arrived, but the run was not paid.
CLOSED means the payroll run was canceled before being paid.
Known values: DRAFT, APPROVED, PAID, FAILED, CLOSED
runTypestringOptionalKnown values: INIT, REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, RECONCILIATION, NEW_HIRE, POP, TRANSITION, CORRECTION_DISPLAY, EXCESS_HOURS, SIGN_ON_BONUS, S_CORP, FRINGE_BENEFITS, CONTRACTOR_LATE_PAYMENTS

SDK function policy ID: rippling.payroll_api.get_payroll_runs. Catalog operation: payroll-api.get-payroll_runs. 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.