List payroll runs

get

https://api.wingspan.app/v3/payments/payroll-runs

List the account's payroll runs. filter[type][eq] (Employee or Contractor) is optional; without it both types are listed. Results are paginated with a page token. Contractor runs from before the account moved to V3 are included; those historical runs have no breakdown.

Results are ordered by payDate descending (most recent payroll first), with id ascending as a stable tiebreak, unless sort says otherwise. When paging a sorted result, repeat the same sort parameter on every page request — the page token is bound to it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

object

Pagination query parameters. Serializes as page[size] and page[token].

sort

object

Sort by exactly one field using sort[payDate]=asc|desc or sort[totalAmount]=asc|desc. Omitted means the default order described above.

filter

object

Filters use deep-object query parameters, for example filter[type][eq]=Employee. filter[type][eq] is optional — omitted lists both worker types. For array operators use filter[field][anyOf][]=value; for the payDate range use filter[payDate][gte]= / filter[payDate][lte]=. filter[failureCode][anyOf][]= narrows to runs that failed for a given reason.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

application/problem+json

200Payroll run list

400Malformed request syntax

401Unauthenticated

403Forbidden

422Validation error

501This operation is not yet available