# 获取勋章列表

可以通过该接口列出租户下所有的勋章，勋章的排列顺序是按照创建时间倒序排列。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/admin/v1/badges
HTTP Method | GET
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查看、创建、编辑勋章信息和上传勋章图片(admin:badge)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
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 | 是 | 分页大小<br>**示例值**：10<br>**默认值**：`10`<br>**数据校验规则**：<br>- 取值范围：`1` ～ `50`
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**："b1fmUz"<br>**数据校验规则**：<br>- 长度范围：`1` ～ `64` 字符
name | string | 否 | 租户内唯一的勋章名称，精确匹配。<br>**示例值**："激励勋章"<br>**数据校验规则**：<br>- 最小长度：`1` 字符

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
badges | badge\[\] | 勋章列表
id | string | 租户内勋章的唯一标识，该值由系统随机生成。
name | string | 租户内唯一的勋章名称，最多30个字符。
explanation | string | 勋章的描述文案，最多100个字符。
detail_image | string | 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。
show_image | string | 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。
i18n_name | i18n | 勋章的多语言名称，同name字段限制，最多30个字符。
zh_cn | string | 中文文案
en_us | string | 英文文案
ja_jp | string | 日文文案
i18n_explanation | i18n | 勋章的多语言描述文案，同explanation字段限制，最多100个字符。
zh_cn | string | 中文文案
en_us | string | 英文文案
ja_jp | string | 日文文案
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
has_more | boolean | 是否还有更多项

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "badges": [
            {
                "id": "m_MzfKDM",
                "name": "激励勋章",
                "explanation": "这枚勋章为了激励员工颁发。",
                "detail_image": "75a1949f-d9df-4b46-bc88-dacc51e88f3j",
                "show_image": "03daa74a-159f-49e9-963e-b6c4d76103fj",
                "i18n_name": {
                    "zh_cn": "激励勋章",
                    "en_us": "Incentive Medal",
                    "ja_jp": "奨励メダル"
                },
                "i18n_explanation": {
                    "zh_cn": "激励勋章",
                    "en_us": "Incentive Medal",
                    "ja_jp": "奨励メダル"
                }
            }
        ],
        "page_token": "h121921",
        "has_more": false
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1051000 | unknown server error | 服务内部错误，请稍后重试
400 | 1051001 | request contain invalid param | 请求中包含非法参数
403 | 1051002 | request to exceed authority | 请求发生越权
403 | 1051003 | the tenant's current payment plan does not support the use of this function | 该租户当前套餐不能使用勋章功能点