Rippling: Retrieve a specific payroll-run

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_payroll_runs

Provider route: GET /payroll-runs/{id}/. Alter supplies the connection’s credentials and routing.

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"]["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.restApi.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.rest_api.get_payroll_runs(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id

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	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
approval_deadline	string	Optional	Deadline for approving the payroll run.
approved_at	string	Optional	Timestamp when the run was approved.
check_date	string	Optional	Date the paycheck is issued.
company_entity_id	string	Optional	Identifier linking this payroll run to the company’s legal entity in the HRIS system.
country_code	string	Optional	ISO country code where the payroll run applies.
debit_date	string	Optional	Date funds are debited from the company’s account.
id	string	Optional	Unique identifier for the payroll run.
lock_deadline	string	Optional	Deadline after which the run is locked for changes.
paid_at	string	Optional	Timestamp when the run was marked as paid.
pay_period	object	Optional	Pay period details for this run.
pay_period.end_date	string	Optional	End date of the pay period.
pay_period.pay_frequency	string	Optional	Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
pay_period.start_date	string	Optional	Start date of the pay period.
payment_type	string	Optional	Payment method used (e.g. WIRE, ACH).
run_state	string	Optional	Current state of the run (e.g. DRAFT, PAID, APPROVED).
run_type	string	Optional	Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
title	string	Optional	Human-readable title of the payroll run.

Referenced models: Retrieve a report run — response body — meta redacted fields item

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_payroll_runs. Catalog operation: 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.

Required provider scopes: ["payroll-runs.read"]

Provider entitlements: ["Global_Payroll"]

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

Official provider source