---
title: "Get Pay Schedules by companyID"
method: GET
path: "/apiHub/payroll/v1/companies/{companyId}/paySchedules"
tags: ["Pay Schedules"]
---

# Get Pay Schedules by companyID

`GET /apiHub/payroll/v1/companies/{companyId}/paySchedules`

## Request

- Base URL: `https://dc1demogwext.paylocity.com`
- URL: `https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/paySchedules`
- Auth: HTTP bearer

> 🚧 Partner Restricted
> 
> This endpoint is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, [please reach out to our team](https://www.paylocity.com/contact/partner-form/) to discuss partnership opportunities.

**Summary Description**

Retrieves pay schedules for the specified company.

## Path parameters

- `companyId` string, required

## Query parameters

- `startDate` string
- `endDate` string
- `includeTotalCount` boolean
- `limit` integer
- `offset` integer

## Headers

- `testMode` boolean
- `Authorization` string, required

## Response `200`

OK

- PaySchedulesV1Response
  - `paySchedules` PayScheduleDto[], nullable: The list of pay schedules associated with the company.
    - `id` string, uuid: The unique identifier of the pay schedule.
    - `payFrequency` string, nullable: The full display name of the pay frequency (e.g., "Weekly", "BiWeekly", "SemiMonthly", "Monthly").
    - `payFrequencyCode` string, nullable: The short code for the pay frequency (e.g., "W", "B", "S", "M").
    - `payScheduleName` string, nullable: The display name of the pay schedule.
    - `payScheduleTypes` string[], nullable: The types of pay that will be included on this schedule (e.g., "Regular Pay", "Expenses")
    - `workWeekStart` string, nullable: The day of the week on which the work week starts (e.g., "Monday").
    - `payPeriods` PayPeriodDto[], nullable: The list of pay periods associated with this pay schedule.
      - `payPeriodId` string, uuid, nullable: The unique identifier for the pay period.
      - `checkDate` string, date, nullable: The date on which paychecks are issued for this pay period.
      - `periodBegin` string, date, nullable: The start date of the pay period.
      - `periodEnd` string, date, nullable: The end date of the pay period.
      - `isPast` boolean, nullable: Indicates whether this pay period's check date has already passed.
      - `status` string, nullable: Indicates the Payroll Status.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error
- `502`: Bad Gateway

---

[API](https://skmtc.dev/paylocity/apis/pay-details-api.md) - [All operations](https://skmtc.dev/paylocity/apis/pay-details-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/pay-details-api/revisions/8cbe85265888?raw)