Rippling: Get Employees PRE List within Pay Run

← global_payroll_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.global_payroll_api.get_gp_employee_payroll

Provider route: GET /platform/api/gp_employee_payroll. 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["globalPayrollApi"]["getGpEmployeePayroll"]>[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.globalPayrollApi.getGpEmployeePayroll(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.global_payroll_api.get_gp_employee_payroll(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.runId	string	Required within parent

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
$	array	Root
$[]	object	Each item
$[].companyId	string	Optional	Identifier of company
$[].computedData	object	Optional
$[].computedData.employeeDeductions	string	Optional	total deduction amount for employee
$[].computedData.employeeTaxes	string	Optional	tax amount for employee
$[].computedData.employerTaxes	string	Optional	tax amount for employer
$[].computedData.grossPay	string	Optional	earning wages before deductions
$[].computedData.imputedPay	string	Optional	benefits that not part of wages but still get taxed
$[].computedData.netPay	string	Optional	earning wages that employees take home
$[].countryCode	string	Optional	Two-letter ISO country code
$[].currency	string	Optional	Currency which employee will get paid by
$[].deductions	object	Optional	A dictionary of mapping deductionCode -> summary of deduction details
$[].deductions.DeductionCode	object	Optional
$[].deductions.DeductionCode.deductionBean	object	Optional
$[].deductions.DeductionCode.deductionBean.eeContributionValue	string	Optional	amount contributed by employee
$[].deductions.DeductionCode.deductionBean.erContributionValue	string	Optional	amount contributed by employer
$[].earningsPerEarningType	object	Optional	A dictionary with key being EarningCode and value is a nested object of earning summary
$[].earningsPerEarningType.EarningCode	object	Optional	Can be Salary, Bonus etc.
$[].earningsPerEarningType.EarningCode.wage	object	Optional
$[].earningsPerEarningType.EarningCode.wage.hours	string	Optional	total hours included for this earning code in this pay run
$[].earningsPerEarningType.EarningCode.wage.rate	string	Optional	value per hours
$[].earningsPerEarningType.EarningCode.wage.value	string	Optional	total amount for this earning code in this pay run
$[].payFrequency	string	Optional	Weekly, Bi-Weekly, Semi-Monthly, Monthly
$[].payScheduleName	string	Optional	Company can define a name for pay schedule, by default this field is “{country name} Default Pay Schedule” for exmaple Canada Default Pay Schedule
$[].preVersionId	string	Optional	Version Control of PRE, everytime there’s an update for a PRE we also update it’s PREVersionId
$[].roleId	string	Optional	EmployeeId
$[].runId	string	Optional	Identifying which pay run this PRE belongs to

Policy, approvals and errors

SDK function policy ID: rippling.global_payroll_api.get_gp_employee_payroll. Catalog operation: global-payroll-api.get-gp_employee_payroll. 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