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 pay periods starting from 6 months ago to the date today. Use the start_date and end_date parameters to change the scope of the response. End dates can be up to 3 months in the future and there is no limit on start dates.
Starting in version '2023-04-01', the eligibleemployees attribute was removed from the response. The eligible employees for a payroll are determined by the employeecompensations returned from the payrolls#prepare endpoint.
scope: payrolls:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | ||
end_date | string | If left empty, defaults to today's date. | |
payroll_types | string | regular and/or transition. Multiple options are comma separated. The default is regular pay periods if nothing is passed in. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
[{"start_date":"2020-01-11","end_date":"2020-01-24","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501","payroll":{"payroll_uuid":"bfd8aad4-9c3f-4ca3-b072-a1b2b3ea689f","check_date":"2020-01-30","processed":true,"payroll_deadline":"2020-01-28","payroll_type":"regular"}},{"start_date":"2020-12-12","end_date":"2020-12-25","pay_schedule_uuid":"cb53db72-612f-4eb1-9b85-389e79cfa510","payroll":{"payroll_uuid":"7ed29b45-4bb1-4d38-bd94-4d607d49fd21","check_date":"2020-12-30","processed":true,"payroll_deadline":"2020-12-28","payroll_type":"regular"}}]