List payrolls

get

https://sandbox.checkhq.com/payrolls

Returns a list of payrolls.

Query Params

company

string

Return payrolls for this company ID.

type

string

enum

Return payrolls of this type.

Allowed:

managed

boolean

Return payrolls of this managed status.

limit

int32

Number of payrolls returned per page. The maximum value is 25.

payday_after

date

Return payrolls whose payday is on or after the provided date (format: YYYY-MM-DD)

payday_before

date

Return payrolls whose payday is on or before the provided date (format: YYYY-MM-DD)

status

string

enum

Return payrolls in a given status

Allowed:

approved

boolean

Filter payrolls based on their approval status

pay_schedule

string

Return payrolls for this pay schedule

string

Filter the list to a specific set of payroll IDs

include_items

boolean

Defaults to false

Return related payroll items directly on each payroll.

include_contractor_payments

boolean

Defaults to false

Return related contractor payments directly on each payroll.

Response

Language

Credentials

Header

Response

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

application/json

200200