Reads all Payroll run participants

Returns the participants of each regular payroll run: the employees whose payroll results
compensations/payroll_results bulk_create accepts. Use it before an import to send results
only for these employees.

Off-cycle runs (any payment_type other than regular, see compensations/payroll_runs) are
rejected. They have no fixed population: most of the company's employees are likely to be
valid for one, so a list from this endpoint would not provide much value when trying to
know who an off-cycle payment is for. Knowing which employees to sync is a task the
integration developer should be responsible for: post them directly to bulk_create, whose
employee checks always act as a guardrail and reject any employee who isn't valid for the
run.

The list is not paginated: every participant is returned in one response. It only
includes employees the caller is allowed to see.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
payroll_run_ids[]
array of strings
required

Regular payroll run ids, at most 5, refers to compensations/payroll_runs endpoint. The only use case so far requests a single run; the limit of 5 leaves margin for future integrations while keeping each request cheap.

payroll_run_ids[]*
employee_ids[]
array of strings

Only consider these employees, refers to employees/employees endpoint. When omitted, every employee the caller can see is considered.

employee_ids[]
Responses

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