Skip to main content
GET
List

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

status
enum<string>[]

Case-insensitive. Comma-separate to match any of several, for example ?status=Awaiting Funds,Processing.

Current payroll status. See Payroll Lifecycle for the meaning of each value and the allowed transitions.

Available options:
Created,
Pending Submission,
Pending Approval,
Awaiting Funds,
Scheduled,
Processing,
Completed,
Rejected,
Deleted

Response

get payrolls response

data
object[]