# 获取角色列表

根据 page_token 与 page_size 对权限角色进行游标分页查询，可查询到的信息包括：权限角色ID、角色名、角色描述。可应用于权限判断等鉴权场景。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/hire/v1/roles
HTTP Method | GET
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 获取招聘权限信息(hire:auth:readonly)<br>更新招聘权限信息(hire:auth)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
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_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ==
page_size | int | 否 | 每页获取记录数量<br>**示例值**：100<br>**默认值**：`10`<br>**数据校验规则**：<br>- 最大值：`200`

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | role\[\] | 角色列表
id | string | 角色 ID
name | i18n | 角色名称
zh_cn | string | 中文
en_us | string | 英文
description | i18n | 角色描述
zh_cn | string | 中文
en_us | string | 英文
scope_of_application | int | 适用范围<br>**可选值有**：<br>- 1：社招<br>- 2：校招<br>- 3：都包含（适用于新版权限）
modify_time | string | 更新时间，单位ms的Unix时间戳
role_status | int | 停启用状态<br>**可选值有**：<br>- 1：启用<br>- 2：停用
role_type | int | 角色类型<br>**可选值有**：<br>- 1：系统内置角色<br>- 2：普通用户<br>- 5：自定义角色
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "101",
                "name": {
                    "zh_cn": "测试",
                    "en_us": "test"
                },
                "description": {
                    "zh_cn": "测试",
                    "en_us": "test"
                },
                "scope_of_application": 1,
                "modify_time": "1716535727510",
                "role_status": 1,
                "role_type": 1
            }
        ],
        "has_more": true,
        "page_token": "eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ=="
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1002002 | 参数错误 | 检查参数是否正确，例如类型，大小