---
title: "Get all Pay Cycles"
method: GET
path: "/payroll/paygroups/{routePayGroupId}/paycycles"
tags: ["PayCycles"]
---

# Get all Pay Cycles

`GET /payroll/paygroups/{routePayGroupId}/paycycles`

## Path parameters

- `routePayGroupId` string, uuid, required

## Query parameters

- `payGroupId` string, uuid
- `month` integer
- `year` integer
- `runStatus` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

OK

- APIPayCycleViewPagedResponse — class represents paged response.
  - `succeeded` boolean — Gets or sets a value indicating whether this Keka.API.Web.Core.Response`1 is succeeded.
  - `message` string, nullable — Gets or sets the message.
  - `errors` string[], nullable — Gets or sets the errors.
  - `data` KekaAPIModelPayrollAPIPayCycleView[], nullable — Gets or sets the data.
    - `identifier` string, nullable
    - `month` string, nullable
    - `startDate` string, nullable
    - `endDate` string, nullable
    - `runStatus` 0 | 1 | 2
  - `pageNumber` integer — Gets or sets the page number.
  - `pageSize` integer — Gets or sets the size of the page.
  - `firstPage` string, uri, nullable — Gets or sets the first page.
  - `lastPage` string, uri, nullable — Gets or sets the last page.
  - `totalPages` integer — Gets or sets the total pages.
  - `totalRecords` integer — Gets or sets the total records.
  - `nextPage` string, uri, nullable — Gets or sets the next page.
  - `previousPage` string, uri, nullable — Gets or sets the previous page.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/keka/apis/keka-api.md) · [All operations](https://skmtc.net/keka/apis/keka-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keka/keka-api/versions/907ea395c885/schema)