飞书项目帮助中心

Appearance

Return to top
页面导航

获取用户详情

请求体说明

类别值
请求地址{base_url}/open_api/user/query
请求方式POST

请求 Header

此接口使用插件身份凭证时，不需要传 user_key。

字段值必须填写
Content-Typeapplication/json必须
X-PLUGIN-TOKEN用户在开放平台中获取的 Token，参考插件身份凭证章节。必须
X-USER-KEY当选择使用插件身份凭证的时候，需要额外必选指定接口调用的用户user_key，user_key可双击用户头像获取可选
X-IDEM-UUID写类型接口的幂等串，可以不设置，设置后会进行同一个X-PLUGIN-TOKEN下同一接口的幂等判断可选

参考请求格式如下：

curl --location -g --request GET '{{base_url}}/open_api/projects' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

请求参数

请求体参数 user_keys、out_ids、emails 三者填一个即可，最多一次可查询 100 个。

参数名是否必填值类型说明
user_keys是list[string]userkey 的数组
out_ids是list[string]larkUnionId 的数组
emails是list[string]email 的数组，使用邮箱查询需要确保飞书上已经绑定企业邮箱。

获取飞书用户的 out_ids，参考飞书开放平台接口文档。

请求体格式 

{
    "user_keys":["XXX"]
}

返回格式 

{
    "data":[
        {
            "user_id":1,
            "user_key":"7012514555133820947",
            "username":"7012514555133820947",
            "email":"test@test.com",
            "name_cn":"测试",
            "name_en":"test",
            "avatar_url":"",
            "out_id":"testOutId",  // 什么是union_id
            "status":"activated" //枚举：resigned：离职；forzen：冻结；activated：使用中
            "channels":[
                {
                    "tenant_group_id": 7,
                    "tenant_name": "test"
                }
            ] //渠道用户才会出现
        }
    ],
    "err": {},
    "err_msg": "",
    "err_code": 0
}