Get a pay schedule

GET {{baseUrl}}/v1/companies/:company_id/pay_schedules/:pay_schedule_id

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

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Acceptstring

RESPONSES

status: OK

{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","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":"A new monthly pay schedule","auto_pilot":false,"active":true}