查询用户组列表

调用该接口查询当前租户下的用户组列表，列表内包含用户组的 ID、名字、成员数量和类型等信息。

注意事项

• 如果应用的通讯录权限范围设置为 全部员工，则通过本接口可查询到租户内所有用户组的信息，否则，仅会查询到应用通讯录权限范围内的用户组信息。了解应用通讯录权限范围，可参见权限范围资源介绍。

• 支持查询到普通用户组和动态用户组的信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/contact/v3/group/simplelist
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	contact:group:readonly 获取用户组信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小，用于限制一次请求所返回的数据条目数。 示例值：50 默认值：50 数据校验规则： - 最大值：100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=
type	int	否	用户组类型。 示例值：1 可选值有： - 1: 普通用户组 - 2: 动态用户组 默认值：1

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ grouplist	group\[\]	用户组列表信息。
└ id	string	用户组 ID，该 ID 可用于删除、更新、查询用户组。
└ name	string	用户组名字。
└ description	string	用户组描述。
└ member_user_count	int	用户组成员中的用户数量。
└ member_department_count	int	普通用户组成员中的部门数量。 说明：动态用户组成员中没有部门。
└ type	int	用户组的类型。 可选值有： - 1: 普通用户组 - 2: 动态用户组
└ department_scope_list	string\[\]	部门范围，以部门 ID 列表形式展示。
└ group_id	string	自定义用户组 ID。
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "grouplist": [
            {
                "id": "g193821",
                "name": "IT 外包组",
                "description": "IT 外包组，需要对该组人群进行细颗粒度权限管控。",
                "member_user_count": 2,
                "member_department_count": 0,
                "type": 1,
                "department_scope_list": [
                    "od-4e6ac4d14bcd5071a37a39de902c7141"
                ],
                "group_id": "4ba51ab38648f9cd"
            }
        ],
        "page_token": "AQD9/Rn9556539ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JDTJJDDPw=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	40003	internal error	内部错误，你可以获取请求的 X-Request-Id，并联系技术支持。
400	40011	page size is invalid	page_size 无效。page_size 取值范围为 1 ~ 100，请调整参数值后重试。
400	40012	page token is invalid error	page_token 无效。你需要检查传入的 page_token 是否为上次请求返回的 page_token 值。

更多错误码信息，参见通用错误码。