Pay Schedules

Get the pay schedules for a company

Changed on

Returns all pay schedules for a company. The pay schedule object captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.

scope: pay_schedules:read

get/v1/companies/{company_id}/pay_schedules

Request

  • Base URL
    https://api.gusto-demo.com
  • Auth
    HTTP bearer

Path parameters

company_idstring required

The UUID of the company

Query parameters

pageinteger

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

perinteger

Number of objects per page. For majority of endpoints will default to 25

Headers

X-Gusto-API-Version'2026-06-15'

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

Response

Successful

uuidstring required

The unique identifier of the pay schedule in Gusto.

versionstring required

The current version of the pay schedule. See the versioning guide for information on how to use this field for optimistic concurrency.

frequency'Every week' | 'Every other week' | 'Twice per month' | 'Monthly' | 'Quarterly' | 'Annually'

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

READ-ONLY in responses. Possible values:

  • Every week: Employees are paid weekly.
  • Every other week: Employees are paid bi-weekly (every two weeks).
  • Twice per month: Employees are paid twice per month. The explicit pay-day fields always represent pay days; explicit period-end fields are populated only for flexible schedules. Legacy day_1/day_2 retain their historical values.
  • Monthly: Employees are paid once per month; use day_1 for the pay day.
  • Quarterly: Employees are paid every three months.
  • Annually: Employees are paid once per year.
anchor_pay_datestring date

The first date that employees on this pay schedule are paid with Gusto (ISO 8601 YYYY-MM-DD).

anchor_end_of_pay_periodstring date

The last date of the first pay period. This can be the same date as the anchor pay date (ISO 8601 YYYY-MM-DD).

day_1integer nullable

Legacy field, retained unchanged for compatibility. The first pay day for Monthly and regular Twice per month schedules, or the first pay-period end day for flexible Twice per month schedules. Prefer the explicit pay-period fields. Do not combine day_1/day_2 with explicit fields in a request.

day_2integer nullable

Legacy field, retained unchanged for compatibility. The second pay day for regular Twice per month schedules, or the second pay-period end day for flexible Twice per month schedules. A value of 31 means the last day of the month. Prefer the explicit pay-period fields. Do not combine day_1/day_2 with explicit fields in a request.

namestring nullable

This field will be hourly when the pay schedule is for hourly employees, salaried when the pay schedule is for salaried employees, the department name if pay schedule is by department, and null when the pay schedule is for all employees.

custom_namestring

A custom name for a pay schedule; defaults to the pay frequency description when none was set by the partner.

When the partner never set a custom name (or cleared it), this field contains the auto-generated description derived from frequency and pay days (e.g. "every 1st and 15th of the month", "every Friday"). When the partner set a custom name on create or update, this field contains that value.

auto_payrollboolean

With automatic payroll enabled, payroll runs automatically one day before payroll deadlines. When false, payroll does not run automatically. Returned for API version 2025-11-15 and later; for earlier versions the response uses auto_pilot instead.

activeboolean

Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned.

workweek_start_day'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' nullable

The day of the week that this pay schedule's workweeks start on, used for regular rate of pay overtime calculations. Null when no workweek start day has been configured (e.g. legacy pay schedules).

Changes

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      response property items/day_1 deprecated

    • info

      response property items/day_2 deprecated