---
title: "List Pay Groups"
method: GET
path: "/hris/paygroups"
tags: ["hris/paygroups"]
---

# List Pay Groups

`GET /hris/paygroups`

## Query parameters

- `remote_data` boolean
- `limit` number
- `cursor` string

## Headers

- `x-connection-token` string, required

## Response `200`

- object
  - `prev_cursor` string, nullable, required
  - `next_cursor` string, nullable, required
  - `data` object[], required
    - `pay_group_name` string, nullable — The name of the pay group
    - `field_mappings` object, nullable — The custom field mappings of the object between the remote 3rd party & Panora
    - `id` string, nullable — The UUID of the pay group record
    - `remote_id` string, nullable — The remote ID of the pay group in the context of the 3rd Party
    - `remote_data` object, nullable — The remote data of the pay group in the context of the 3rd Party
    - `remote_created_at` string, date-time, nullable — The date when the pay group was created in the 3rd party system
    - `created_at` string, date-time, nullable — The created date of the pay group record
    - `modified_at` string, date-time, nullable — The last modified date of the pay group record
    - `remote_was_deleted` boolean, nullable — Indicates if the pay group was deleted in the remote system

## Changes

- **2024-08-16** `660a45415efe` — 9 info
  - added the optional property `allOf[subschema #2]/data/items/created_at` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/data/items/field_mappings` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/data/items/id` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/data/items/modified_at` to the response with the `200` status
  - …5 more
- **2024-08-14** `17251bf7794f` — 1 breaking
  - for the `query` request parameter `limit`, default value `50` was added
- **2024-08-09** `3539cfe8509c` — 1 breaking
  - for the `query` request parameter `limit`, default value `30` was removed
- **2024-08-07** `3ce49f5aad53` — 1 breaking
  - for the `query` request parameter `limit`, default value `30` was added
- **2024-08-05** `ca0fa45ebd05` — 1 breaking, 1 info
  - for the `query` request parameter `limit`, default value `50` was removed
  - api operation id `listHrisPaygroup` removed and replaced with `listHrisPaygroups`

[Full history](https://skmtc.dev/panoratech/apis/panora-api-2/changes/hris/paygroups/get.md)

---

[API](https://skmtc.dev/panoratech/apis/panora-api-2.md) · [All operations](https://skmtc.dev/panoratech/apis/panora-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/panoratech/apis/panora-api-2/revisions/be3dc330edf3?raw)