API Reference

List payrolls

get
https://node.friday-staging.com/partner/v1/payrolls

Retrieve a paginated list of payrolls for your company. Supports filtering by status, year, payroll type, and pay frequency. Results are sorted by payday descending. Requires the payroll plan or higher.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number (1-indexed)

integer
1 to 100
Defaults to 25

Number of payrolls per page (max 100)

string
enum

Filter by payroll status

Allowed:
integer

Filter payrolls by year. Uses payday for non-skipped payrolls and period_end for skipped payrolls. When omitted, returns payrolls from all years.

string
enum

Filter by payroll type

Allowed:
string
enum

Filter by pay frequency

Allowed:
Responses

Updated 23 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago