Get the pay schedules for a company
GET {{baseUrl}}/v1/companies/:company_id/pay_schedules?page=<number>&per=<number>
The pay schedule object in Gusto captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.
scope: pay_schedules:read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page | string | The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. | |
per | string | Number of objects per page. For majority of endpoints will default to 25 |
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
[{"uuid":"2097fe08-407a-46d7-b35c-a32402a2355e","frequency":"Twice per month","anchor_pay_date":"2020-05-15","anchor_end_of_pay_period":"2020-05-08","day_1":15,"day_2":31,"name":"Engineering","custom_name":"Engineering department pay schedule","auto_pilot":false,"active":true},{"uuid":"8fc9f556-74fa-4271-97f6-4bfbfc5a5352","frequency":"Monthly","anchor_pay_date":"2020-05-31","day_1":31,"day_2":null,"name":"Sales","custom_name":"Sales department monthly schedule","auto_pilot":false,"active":false},{"uuid":"0e07d35a-af11-4123-bfcb-4dd5f2f12ee1","frequency":"Monthly","anchor_pay_date":"2020-05-31","day_1":31,"day_2":null,"name":"Staff","custom_name":"Staff department pay schedule","auto_pilot":true,"active":false}]