查询用户组列表

通过该接口可查询企业的用户组列表。如果应用的通讯录权限范围是“全部员工”，则可获取企业全部用户组列表。

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/contact/group/simplelist
HTTP Method	GET
支持的应用类型	自建应用
权限要求	获取用户组信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：50
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值："AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw="

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟group_list	group[]	用户组列表
∟group_id	string	用户组ID
∟name	string	用户组名字
∟member_user_count	int	用户组成员中用户的数量
∟member_department_count	int	用户组成员中部门的数量。
∟page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
∟has_more	boolean	是否还有更多项

响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "success": true,
  "data": {
    "group_list": [
      {
        "group_id": "zloKKu33NBzg1NjW5",
        "name": "开放平台用户组01",
        "member_user_count": 0,
        "member_department_count": 0
      },
      {
        "group_id": "4TNWkYgimaKRCWCt",
        "name": "开放平台用户组01",
        "member_user_count": 0,
        "member_department_count": 0
      }
    ],
    "page_token": null,
    "has_more": false
  },
  "msg": "操作成功"
}