Sign in

v4

OpenAPI 3.1.02026-08-034697208.8 KB
Income and Employment

List Paystubs

The paystubs endpoint allows you to query for payouts to an end user. Each paystub contains broken out and aggregated earnings information, as well as relevant dates. Paystubs are returned in reverse chronological order by pay_date. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

get/accounts/{account_id}/paystubs

Path parameters

account_idstring uuid required

UUID of the payroll account.

UUID of the payroll account.

Query parameters

from_pay_datestring date

Filter for paystubs with pay dates after this date.

Filter for paystubs with pay dates after this date.

to_pay_datestring date

Filter for paystubs with pay dates before this date.

Filter for paystubs with pay dates before this date.

cursorstring

Cursor for the page you want to retrieve.

Cursor for the page you want to retrieve.

limitinteger

The maximum number of results to return.

The maximum number of results to return.

Headers

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

Response

OK