查询指定用户组

调用该接口通过用户组 ID 查询指定用户组的基本信息，包括用户组名称、成员数量和类型等。

注意事项

• 应用的通讯录权限范围需要符合以下任一设置，才可以成功调用本接口。了解应用通讯录权限范围，可参见权限范围资源介绍。

  • 通讯录权限范围设置为 全部员工。
  • 由企业管理员在管理后台设置应用可见范围内包含当前待查询的用户组，然后应用的通讯录权限范围设置为 与应用的可用范围一致。

• 支持查询普通用户组和动态用户组。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/contact/v3/group/:group_id
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	contact:group:readonly 获取用户组信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称	类型	描述
group_id	string	用户组 ID。 用户组 ID 可在创建用户组时从返回值中获取，你也可以调用查询用户组列表接口，获取用户组的 ID。 示例值："g193821"

查询参数

名称	类型	必填	描述
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，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
department_id_type	string	否	此次调用中的部门 ID 类型。关于部门 ID 的详细介绍，可参见部门 ID 说明。 示例值：open_department_id 可选值有： - open_department_id: 由系统自动生成的部门 ID，ID 前缀固定为 od-，在租户内全局唯一。 - department_id: 支持用户自定义配置的部门 ID。自定义配置时可复用已删除的 department_id，因此在未删除的部门范围内 department_id 具有唯一性。

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ group	group	用户组详情。
└ id	string	用户组 ID。
└ name	string	用户组名字。
└ description	string	用户组描述。
└ member_user_count	int	用户组成员中的用户数量。
└ member_department_count	int	普通用户组内成员中的部门数量。 说明：动态用户组成员中没有部门。
└ type	int	用户组的类型。 可选值有： - 1: 普通用户组 - 2: 动态用户组

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "group": {
            "id": "g193821",
            "name": "IT 外包组",
            "description": "IT 外包组，需要对该组人群进行细颗粒度权限管控。",
            "member_user_count": 2,
            "member_department_count": 0,
            "type": 1
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	40003	internal error	内部错误，你可以获取请求的 X-Request-Id，并联系技术支持。
400	42002	invalid group_id	用户组 ID 无效。请检查传入的用户组 ID 是否正确，你可以调用查询用户组列表接口，获取用户组的 ID。
400	42029	exist some field openapi not support, please manage the group in admin platform	部分字段在OpenAPI接口中未被支持，请在管理后台页面中调整对应的用户组设置。

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