Sign in

v5

latestOpenAPI 3.1.02026-08-044697208.6 KB
Company Connect
Company Connect

List Employee Paystubs

List employee paystubs data reported by the payroll platform. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

get/company_connections/{company_connection_id}/paystubs/{employee_external_id}

Path parameters

company_connection_idstring uuid required

UUID of the Company Connection.

UUID of the Company Connection.

employee_external_idstring required

Employee ID as reported by their employer.

Employee ID as reported by their employer.

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