List external payrolls
get/external_payrolls
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
idstring
ID(s) of the payroll to return.
companystring
Return payrolls for this company ID.
pay_schedulestring
Return payrolls for this pay schedule
include_itemsboolean
When false, return a summary representation that omits embedded items and contractor_payments from each payroll.
Response
200
object required
Changes
No recorded changes to this operation across all 2 revisions of this API.