---
title: "Get all Pay Groups"
method: GET
path: "/payroll/paygroups"
tags: ["PayGroups"]
---

# Get all Pay Groups

`GET /payroll/paygroups`

Gets all Pay Groups.

## Query parameters

- `pageNumber` integer
- `pageSize` integer

## Response `200`

OK

- APIPayGroupViewPagedResponse — 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` KekaAPIModelPayrollAPIPayGroupView[], nullable — Gets or sets the data.
    - `id` integer
    - `identifier` string, nullable
    - `name` string, nullable
    - `description` string, nullable
    - `legalEntityId` string, nullable
    - `legalEntityName` string, nullable
    - `esiStatutoryDetails` KekaAPIModelPayrollAPIESIStatutoryDetails[], nullable
      - `id` string, uuid
      - `name` string, nullable
      - `establishmentId` string, nullable
    - `pfStatutorydetails` KekaAPIModelPayrollAPIPFStatutoryDetails[], nullable
      - `id` string, uuid
      - `name` string, nullable
      - `establishmentId` string, nullable
    - `ptStatutoryDetails` KekaAPIModelPayrollAPIPTStatutoryDetails[], nullable
      - `id` string, uuid
      - `registeredLocation` string, nullable
      - `establishmentId` string, nullable
      - `otherApplicableStates` string[], nullable
  - `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/revisions/907ea395c885/schema)