GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Preview pay schedule dates

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

Returns a preview of pay period dates and holidays for the given parameters (e.g. frequency, anchor pay date) for the next 18 months. Use this before creating or updating a pay schedule to show expected check dates 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.

Allowed:
date
required

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

date
required

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

integer

First pay day of the month (1-31).

  • Twice per month, Monthly: required.
  • Every week, Every other week: omit or null.
integer

Second pay day of the month (1-31); only for Twice per month.

  • Use 31 for last day of month (shorter months use the actual last day).
  • Other frequencies: omit or null.
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 5 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 5 days ago