# 获取薪资组基本信息

- 薪资组是按薪酬管理的纬度创建的组，组内的员工由相同的HR处理薪酬相关工作，通过薪资组可实现对薪资组人员的管理和在薪酬计算发放等环节的人员权限范围控制
- 本接口返回所有薪资组的基本信息，包括薪资组ID、薪资组名称、薪资组编码、薪资组状态等，不含薪资组下的员工信息

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/payroll/v1/paygroups
HTTP Method | GET
接口频率限制 | [20 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取薪资组信息(payroll:pay_groups:read)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
page_size | int | 否 | 分页大小，默认值100<br>**示例值**：50<br>**数据校验规则**：<br>- 取值范围：`1` ～ `2000`
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：6862995757234914824

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | paygroup\[\] | 薪资组列表
pay_group_id | string | 薪资组ID
name | i18n | 薪资组名称
zh_cn | string | 中文名称
en_us | string | 英文名称
code | string | 薪资组编码
status | int | 薪资组状态<br>**可选值有**：<br>- 1：启用<br>- 0：禁用
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
has_more | boolean | 是否还有更多项

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "pay_group_id": "6823630319749580301",
                "name": {
                    "zh_cn": "CHN-审核",
                    "en_us": "english name"
                },
                "code": "PAY_GROUP-3-8",
                "status": 1
            }
        ],
        "page_token": "6862995757234914824",
        "has_more": true
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 2500001 | unknown error | 内部服务错误，请咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)
404 | 2500002 | param invalid | 参数错误，请检查参数
500 | 2500003 | rpc fail | 请重试，如仍失败请咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)