The Pay Schedule Group Object

A pay schedule group defines a named collection of employees that share a common pay frequency and pay period schedule. Companies on premium plans can create multiple groups (e.g. "Weekly Hourly", "Biweekly Salaried"); companies on other plans have a single default group.

Variants

Shape	Returned by	Extra fields
List item	`GET /pay-schedule-groups`	`employee_count`
Detail	`GET /pay-schedule-groups/:pay_schedule_group_id`	`employee_ids`, `pay_periods`

The list and detail shapes share pay_schedule_group_id, name, is_default, and pay_frequency but differ in the additional fields they include.

Field Reference

Shared fields

Field	Type	Description
`pay_schedule_group_id`	integer	Unique pay schedule group identifier.
`name`	string	Group name (e.g. `"Default pay schedule"`).
`is_default`	boolean	Whether this is the company's default pay schedule group.
`pay_frequency`	string \| null	Current pay frequency derived from the active schedule. Null if no active schedule exists. Values: `"weekly"`, `"biweekly"`, `"semimonthly"`, `"monthly"`, `"quarterly"`.

List-only fields

Field	Type	Description
`employee_count`	integer	Number of employees assigned to this group.

Detail-only fields

Field	Type	Description
`employee_ids`	integer[]	IDs of all employees assigned to this group.
`pay_periods`	array	All pay periods (historical and future) sorted chronologically. See Pay Period.

Nested Objects

Pay Period

Field	Type	Description
`period_start`	string	Start date of the pay period (`YYYY-MM-DD`).
`period_end`	string	End date of the pay period (`YYYY-MM-DD`).
`check_date`	string \| null	Pay date / check date for this period (`YYYY-MM-DD`).

Example: List Item

{
  "pay_schedule_group_id": 5,
  "name": "Default pay schedule",
  "is_default": true,
  "pay_frequency": "biweekly",
  "employee_count": 12
}

Example: Detail

{
  "pay_schedule_group_id": 5,
  "name": "Default pay schedule",
  "is_default": true,
  "pay_frequency": "biweekly",
  "employee_ids": [101, 102, 103],
  "pay_periods": [
    {
      "period_start": "2026-03-16",
      "period_end": "2026-03-29",
      "check_date": "2026-04-03"
    },
    {
      "period_start": "2026-03-30",
      "period_end": "2026-04-12",
      "check_date": "2026-04-17"
    }
  ]
}

Payroll object
Employee object — pay_schedule_group field

Object overview