Skip to content

Rippling: List payroll-runs — response body — results item

List payroll-runs: response body, field results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: List payroll-runs — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
V2 DTO representing a single payroll run.

Used by:
- GET /payroll-runs/ (list)
- GET /payroll-runs/{id} (retrieve)
approval_deadlinestringOptionalDeadline for approving the payroll run.
approved_atstringOptionalTimestamp when the run was approved.
check_datestringOptionalDate the paycheck is issued.
company_entity_idstringOptionalIdentifier linking this payroll run to the company’s legal entity in the HRIS system.
country_codestringOptionalISO country code where the payroll run applies.
debit_datestringOptionalDate funds are debited from the company’s account.
idstringOptionalUnique identifier for the payroll run.
lock_deadlinestringOptionalDeadline after which the run is locked for changes.
paid_atstringOptionalTimestamp when the run was marked as paid.
pay_periodobjectOptionalPay period details for this run.
pay_period.end_datestringOptionalEnd date of the pay period.
pay_period.pay_frequencystringOptionalPay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
pay_period.start_datestringOptionalStart date of the pay period.
payment_typestringOptionalPayment method used (e.g. WIRE, ACH).
run_statestringOptionalCurrent state of the run (e.g. DRAFT, PAID, APPROVED).
run_typestringOptionalType of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
titlestringOptionalHuman-readable title of the payroll run.

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.