Rippling: GET Employees in a Payroll Run
Rippling payrollApi.getPayrollRunsPayrollRunIdEmployees: arguments, response, policy and SDK examples.
← Payroll API operations · Get started
Operation rippling.payroll_api.get_payroll_runs_payrollrunid_employees
Provider route: GET /platform/api/payroll_runs/{payrollRunId}/employees. 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["payrollApi"]["getPayrollRunsPayrollRunIdEmployees"]>[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.getPayrollRunsPayrollRunIdEmployees(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.payroll_api.get_payroll_runs_payroll_run_id_employees(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.payrollRunId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.ein | integer | Optional | |
query.role | string | Optional | |
query.limit | integer | Optional | |
query.offset | integer | Optional |
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 |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand POST Payroll Earnings — response body |
Referenced models: POST Payroll Earnings — response body
Schemas
Section titled “Schemas”POST Payroll Earnings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An employee payroll run object. |
credits | array | Optional | |
credits[] | Model | Each item | Expand POST Payroll Earnings — response body — credits item |
debits | array | Optional | |
debits[] | Model | Each item | Expand POST Payroll Earnings — response body — debits item |
earnings | array | Optional | |
earnings[] | JSON | Each item | |
earnings[] (anyOf 1) | Model | Alternative | Expand POST Payroll Earnings — request body — body A pay earning object for an employee |
earnings[] (anyOf 2) | null | Alternative | |
ein | string | Optional | |
garnishments | array | Optional | |
garnishments[] | Model | Each item | Expand POST Payroll Earnings — response body — garnishments item |
grossPay | string | Optional | |
id | string | Optional | |
netPay | string | Optional | |
role | string | Optional | The unique identifier of the employee. |
run | string | Optional | |
taxes | array | Optional | |
taxes[] | Model | Each item | Expand POST Payroll Earnings — response body — taxes item |
totalPayForPercentageDeductions | string | Optional |
Referenced models: POST Payroll Earnings — response body — credits item, POST Payroll Earnings — response body — debits item, POST Payroll Earnings — response body — garnishments item, POST Payroll Earnings — response body — taxes item, POST Payroll Earnings — request body — body A pay earning object for an employee
POST Payroll Earnings — response body — credits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing employee credits. |
amount | string | Optional | Credit Amount. |
name | string | Optional | Credit Name. |
POST Payroll Earnings — response body — debits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing employee debits. |
amount | string | Optional | Debit Amount. |
name | string | Optional | Debit Name. |
POST Payroll Earnings — response body — garnishments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing employee garnishments. A payroll garnishment occurs when a court issues an order to withhold a certain amount from an employee's paycheck and send it directly to the organization or person owed money, until the debt is fully paid. |
ctdAmt | string | Optional | Contribution Amount. |
employeeGarnishment | string | Optional | Unique identifier of the garnishmnet type defined by the company. |
name | string | Optional | Garnishment Name. |
POST Payroll Earnings — response body — taxes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tax object that depicts taxes paid by an employee during a payroll run. |
amount | string | Optional | |
isERTax | boolean | Optional | |
name | string | Optional |
POST Payroll Earnings — request body — body A pay earning object for an employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A pay earning object for an employee. |
amount | string | Optional | |
companyEarningType | string | Optional | Identifier of the earning type defined by the company. There can only be one entry in the earnings array for each companyEarningType. |
earningTypeEnum | string | Optional | |
hours | JSON | Optional | |
hours (anyOf 1) | string | Alternative | Only applies to earning types that are paid hourly. |
hours (anyOf 2) | null | Alternative | |
shiftId | JSON | Optional | |
shiftId (anyOf 1) | string | Alternative | Used to distinguish between earnings with same time labels |
shiftId (anyOf 2) | null | Alternative | |
time_labels | JSON | Optional | |
time_labels (anyOf 1) | array | Alternative | List of Jobcodes for the Earning hours |
time_labels (anyOf 1)[] | string | Each item | |
time_labels (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.payroll_api.get_payroll_runs_payrollrunid_employees. Catalog operation: payroll-api.get-payroll_runs-payrollRunId-employees. 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.