GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Preview pay schedule dates

get
https://api.gusto-demo.com/v1/companies//pay_schedules/preview

Provides a preview of a pay schedule with the specified parameters for the next 18 months. Use this before creating or updating a pay schedule to show expected check dates, pay period boundaries, and payroll deadlines.

Related guides

scope: pay_schedules:write

Path Params
string
required

The UUID of the company

Query Params
string
enum
required

The frequency that employees on this pay schedule are paid with Gusto.

Allowed:
date
required

The first date that employees on this pay schedule are paid with Gusto.

date
required

The last date of the first pay period. This can be the same date as the anchor pay date.

integer

An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the "Twice per month" and "Monthly" frequencies. It will be null for pay schedules with other frequencies.

integer

An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the "Twice per month" frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, the second pay date is set to the last day of the month. It will be null for pay schedules with other frequencies.

date

End date for the preview range. If given, this date must be in the future. When unspecified, defaults to 18 months from today.

Headers
string
enum
Defaults to 2026-02-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:
Responses

Updated 25 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago