v4

OpenAPI 3.1.02026-08-034697208.8 KB
Jobs

List Completed Jobs

List all completed jobs which were initiated by Link (i.e., excluding refresh jobs for monitoring). This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

get/jobs

Query parameters

job_typesstring[]

List of job types. May be expanded to include new enum values (see our Change Management policy).

List of job types. May be expanded to include new enum values (see our Change Management policy).

link_token_idstring uuid

UUID of the link token triggering the job.

UUID of the link token triggering the job.

account_idstring uuid

UUID of the payroll account.

UUID of the payroll account.

outcome'success' | 'error' | 'pending'

The outcome of the job.

The outcome of the job.

limitinteger

The maximum number of results to return.

The maximum number of results to return.

cursorstring

Cursor for the page you want to retrieve.

Cursor for the page you want to retrieve.

from_timestampstring date-time

Return results after this ISO 8601 timestamp.

Return results after this ISO 8601 timestamp.

to_timestampstring date-time

Return results to this ISO 8601 timestamp.

Return results to this ISO 8601 timestamp.

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