GEgetpinwheel
Jobs

List Completed Jobs

Changed on

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

Request

Query parameters

job_typesstring[]

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.

account_idstring uuid

UUID of the payroll account.

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

The outcome of the job.

partner_customer_idstring

The identifier for a partner's customer. This field is required for banking platforms and resellers. The value supplied must be preregistered with Pinwheel's customer success team.

limitinteger

The maximum number of results to return.

cursorstring

Cursor for the page you want to retrieve.

from_timestampstring date-time

Return results after this ISO 8601 timestamp.

to_timestampstring date-time

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

Changes

  • b3f26a100b47Revision changes
    • info

      added the new optional query request parameter partner_customer_id

  • 372b93d1c20dRevision changes
    • breaking

      removed the enum value paycheck_viewer from the property items/ of the query request parameter job_types

    • info

      removed the paycheck_viewer enum value from the // response property for the response status