List Completed Jobs

get

https://api.getpinwheel.com/v1/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 here.

Query Params

link_token_id

uuid

UUID of the link token triggering the job.

account_id

uuid

UUID of the payroll account.

job_types

array of strings

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

job_types

outcome

string

enum

The outcome of the job.

Allowed:

limit

integer

1 to 100

Defaults to 25

The maximum number of results to return.

cursor

string

Cursor for the page you want to retrieve.

from_timestamp

date-time

Return results after this ISO 8601 timestamp.

to_timestamp

date-time

Return results to this ISO 8601 timestamp.

Headers

Pinwheel-Version

string

enum

required

Defaults to 2022-09-09

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

Allowed:

Response

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK