获取单个用户信息

GET

https://open.feishu.cn/open-apis/contact/v3/users/{user_id}

该接口用于获取通讯录中单个用户的信息。
权限要求（开启任一权限即可）：
以应用身份读取通讯录
以应用身份访问通讯录
历史版本
读取通讯录
历史版本
字段权限要求：
该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请

获取用户性别
以应用身份读取通讯录
获取用户基本信息
获取用户组织架构信息
获取用户受雇信息
获取用户邮箱信息
仅自建应用
获取用户手机号
仅自建应用
获取用户 user ID
仅自建应用
以应用身份访问通讯录
历史版本
读取通讯录

错误码

HTTP状态码	错误码	描述	排查建议
400	41050	no user authority error	操作的用户需在通讯录权限范围中，了解更多
400	40001	param error	参数错误。
400	41012	user id invalid error	用户ID无效。
400	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/contact/v3/users/' \
--header 'Authorization;'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "user": {
            "union_id": "on_94a1ee5551019f18cd73d9f111898cf2",
            "user_id": "3e3cf96b",
            "open_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
            "name": "张三",
            "en_name": "San Zhang",
            "nickname": "Alex Zhang",
            "email": "zhangsan@gmail.com",
            "mobile": "13011111111 (其他例子，中国大陆手机号: 13011111111 或 +8613011111111, 非中国大陆手机号:  +41446681800)",
            "mobile_visible": false,
            "gender": 1,
            "avatar": {
                "avatar_72": "https://foo.icon.com/xxxx",
                "avatar_240": "https://foo.icon.com/xxxx",
                "avatar_640": "https://foo.icon.com/xxxx",
                "avatar_origin": "https://foo.icon.com/xxxx"
            },
            "status": {
                "is_frozen": false,
                "is_resigned": false,
                "is_activated": true,
                "is_exited": false,
                "is_unjoin": false
            },
            "department_ids": [
                "od-4e6ac4d14bcd5071a37a39de902c7141"
            ],
            "leader_user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
            "city": "杭州",
            "country": "CN",
            "work_station": "北楼-H34",
            "join_time": 2147483647,
            "is_tenant_manager": false,
            "employee_no": "1",
            "employee_type": 1,
            "orders": [
                {
                    "department_id": "od-4e6ac4d14bcd5071a37a39de902c7141",
                    "user_order": 100,
                    "department_order": 100
                }
            ],
            "custom_attrs": [
                {
                    "type": "TEXT",
                    "id": "DemoId",
                    "value": {
                        "text": "DemoText",
                        "url": "http://www.fs.cn",
                        "pc_url": "http://www.fs.cn",
                        "option_value": "option",
                        "name": "name",
                        "picture_url": "https://xxxxxxxxxxxxxxxxxx",
                        "generic_user": {
                            "id": "9b2fabg5",
                            "type": 1
                        }
                    }
                }
            ],
            "enterprise_email": "demo@mail.com",
            "job_title": "xxxxx"
        }
    }
}

请求参数

Path 参数

user_id

string

必需

Query 参数

user_id

string

可选

用户ID，类型需要与查询参数中的user_id_type保持一致。例如user_id_type=open_id，user_id的类型需为open_id 不同ID的说明参见用户相关的 ID 概念示例值："7be5fg9a"

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的类型不同 ID 的说明部门ID说明示例值："open_department_id" 可选值有： department_id：以自定义department_id来标识部门 open_department_id：以open_department_id来标识部门默认值：open_department_id

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

必需

user

object

用户信息

必需

修改于 2023-01-12 03:42:23

更新用户所有信息

获取部门直属用户列表

获取单个用户信息

错误码#

请求参数

返回响应

错误码