获取授予名单列表

GET

https://open.feishu.cn/open-apis/admin/v1/badges/{badge_id}/grants

通过该接口可以获取特定勋章下的授予名单列表，授予名单的排列顺序按照创建时间倒序排列。

错误码

HTTP状态码	错误码	描述	排查建议
500	1051000	unknown server error	服务内部错误，请稍后重试
400	1051001	request contain invalid param	请求中包含非法参数
403	1051002	request to exceed authority	请求发生越权
400	1051113	cannot find this badge	未找到该勋章的信息

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/admin/v1/badges//grants?page_size=&page_token=&user_id_type=&department_id_type=&name=' \
--header 'Authorization;'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "grants": [
            {
                "id": "g_49Z7CQ",
                "badge_id": "m_qTR2HM",
                "name": "激励勋章的授予名单",
                "grant_type": 0,
                "time_zone": "Asia/Shanghai",
                "rule_detail": {
                    "effective_time": "1649606400",
                    "expiration_time": "1649692799",
                    "anniversary": 1,
                    "effective_period": 1
                },
                "is_grant_all": false,
                "user_ids": [
                    "u273y71"
                ],
                "department_ids": [
                    "h121921"
                ],
                "group_ids": [
                    "g122817"
                ]
            }
        ],
        "page_token": "om5fn1",
        "has_more": false
    }
}

请求参数

Path 参数

badge_id

string

必需

企业勋章的唯一ID

示例值："m_DjMzaK"

数据校验规则：

长度范围：1 ～ 64 字符

Query 参数

page_size

string

必需

分页大小

示例值：10

默认值：10

数据校验规则：

最大值：50

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果

示例值："om5fn1"

user_id_type

string

可选

用户 ID 类型

示例值："open_id"

可选值有：

open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID
union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？
user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？
默认值：open_id

当值为 user_id，字段权限要求：

获取用户 user ID

department_id_type

string

可选

此次调用中使用的部门ID的类型。

示例值："open_department_id"

可选值有：

department_id：以自定义department_id来标识部门
open_department_id：以open_department_id来标识部门
默认值：open_department_id

name

string

可选

授予名单名称，精确匹配。

示例值："激励勋章的授予名单"

数据校验规则：

最小长度：1 字符

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

grants

object

授予名单的信息

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

has_more

boolean

是否还有更多项

必需

修改于 2023-02-03 10:09:50

修改授予名单

获取授予名单详情

获取授予名单列表

错误码#

请求参数

返回响应

错误码