Get pay periods for a company

get https://api.gusto-demo.com/v1/companies/{company_id}/pay_periods

Pay periods are the foundation of payroll. Compensation, time & attendance, taxes, and expense reports all rely on when they happened. To begin submitting information for a given payroll, we need to agree on the time period.

By default, this endpoint returns pay periods starting from 6 months ago to the date today. Use the start_date and end_date parameters to change the scope of the response. End dates can be up to 3 months in the future and there is no limit on start dates.

Starting in version '2023-04-01', the eligible_employees attribute was removed from the response. The eligible employees for a payroll are determined by the employee_compensations returned from the payrolls#prepare endpoint.

scope: payrolls:read

Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.gusto-demo.com/v1/companies/company_id/pay_periods \
3
     --header 'X-Gusto-API-Version: 2024-04-01' \
4
     --header 'accept: application/json'


xxxxxxxxxx
26
]
1
[
2
  {
3
    "start_date": "2020-01-11",
4
    "end_date": "2020-01-24",
5
    "pay_schedule_uuid": "00ebc4a4-ec88-4435-8f45-c505bb63e501",
6
    "payroll": {
7
      "payroll_uuid": "bfd8aad4-9c3f-4ca3-b072-a1b2b3ea689f",
8
      "check_date": "2020-01-30",
9
      "processed": true,
10
      "payroll_deadline": "2020-01-28",
11
      "payroll_type": "regular"
12
    }
13
  },
14
  {
15
    "start_date": "2020-12-12",
16
    "end_date": "2020-12-25",
17
    "pay_schedule_uuid": "cb53db72-612f-4eb1-9b85-389e79cfa510",
18
    "payroll": {
19
      "payroll_uuid": "7ed29b45-4bb1-4d38-bd94-4d607d49fd21",
20
      "check_date": "2020-12-30",
21
      "processed": true,
22
      "payroll_deadline": "2020-12-28",
23
      "payroll_type": "regular"
24
    }
25
  }

200Example response