Get pay periods for a company

GET {{baseUrl}}/v1/companies/:company_id/pay_periods?start_date=<string>&end_date=<string>&payroll_types=<string>

Pay periods are the foundation of payroll. Compensation, time & attendance, taxes, and expense reports all rely on when they happened. To begin submitting information for a given payroll, we need to agree on the time period.

By default, this endpoint returns every current and past pay period for a company. Since companies can process payroll as often as every week, there can be up to 53 pay periods a year. If a company has been running payroll with Gusto for five years, this endpoint could return up to 265 pay periods. Use the start_date and end_date parameters to reduce the scope of the response.

scope: payrolls:read

Request Params

HEADERS

RESPONSES

status: OK

[{"start_date":"2020-01-11","end_date":"2020-01-24","pay_schedule_id":1409756036510222,"pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501","eligible_employees":[{"id":7740244452464965,"uuid":"26c2359e-78d3-4450-b2e4-661e2a655a17","job_ids":[7740244454306064],"job_uuids":["7d01ef7b-5ef5-4d73-aaac-148789fa79ad"]},{"id":7757869431131641,"uuid":"9fde3f01-c7e8-4a65-95ec-1e5a74549e61","job_ids":[7757869439389315],"job_uuids":["618dac73-5450-4045-865d-8168e0863ce6"]}],"payroll":{"processed":true,"payroll_deadline":"2020-01-28","payroll_type":"regular"}},{"start_date":"2020-12-12","end_date":"2020-12-25","pay_schedule_id":1409756036510224,"pay_schedule_uuid":"cb53db72-612f-4eb1-9b85-389e79cfa510","eligible_employees":[{"id":1409722316858016,"uuid":"699f4da3-a032-4c87-b33a-02b1efffa494","job_ids":[1409722316881160],"job_uuids":["ac05c860-8fc4-4fa7-a949-bee924379bb6"]},{"id":7757869431131645,"uuid":"7a03c791-cc99-48e6-85f2-26d4b6d26b62","job_ids":[7757869439389316],"job_uuids":["0e66ad7d-33a4-4f40-aa94-eff3ee5a7812"]}],"payroll":{"processed":true,"payroll_deadline":"2020-12-28","payroll_type":"regular"}}]