Skip to main content
GET
List payroll runs by tax year

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Path Parameters

year
integer
required

The year in format yyyy

Example:

2024

Query Parameters

pageSize
integer

The maximum number of payroll runs to return.

Required range: 1 <= x <= 100
paginationToken
string

The pagination token for the next page.

Response

Payroll runs listed successfully

The response is of type any.