Rippling: Get Company Pay Run List

← global_payroll_api operations · Get started · OpenAPI downloads

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

Provider route: GET /platform/api/gp_company_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"]["getGpCompanyPayroll"]>[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.getGpCompanyPayroll(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_company_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.countryCode	string	Required within parent
query.from	string	Optional
query.to	string	Optional
query.runStatus	string	Optional

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
$[].approveBy	string	Optional	The date this run must be approved by
$[].checkDate	string	Optional	the date when employees will get paid
$[].companyEntityRelationshipId	string	Optional	This is the unique ID of the legal entity. This ID will match the entity ID returned on GET/Employees and GET/Current Company.
$[].companyPayrollEntityId	string	Optional	This is an internal ID of the legal entity in Rippling global payroll. This ID is different than the entity ID returned on GET/Employees and GET/Current Company.
$[].countryCode	string	Optional	Two-letter ISO country code
$[].debitDate	string	Optional	the date this run will get debit
$[].endDate	string	Optional	endDate of pay run
$[].paymentType	string	Optional	Display what kind of paymentType company choose to pay
$[].payrollEntityLegalName	string	Optional	Legal name of the entity
$[].runId	string	Optional	Unique id of this run
$[].runStatus	string	Optional	A full lift cycle of run: DRAFT -> APPROVED -> PAID
$[].runType	string	Optional	Generally we have REGULAR, OFFCYCLE, TERMINATION, EXCESS_HOURS, INTERIM, REGULAR run is most common runs that we should pay attention
$[].runVersionId	string	Optional	RunVersion is the version control of each run. Everytime a payrun is getting update we generate a different countryRunVersionId. RunVersionId are usually used in finding related PayRunEntries(PREs)
$[].startDate	string	Optional	startDate of the pay run
$[].title	string	Optional	Pay Run Title

Policy, approvals and errors

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