Developer API
V2

获取用户信息

获取指定用户的基础资料,并根据权限决定是否返回邮箱。

GET /v2/users/:user_id

获取用户信息

适用场景

当你已经知道某个用户的 ID,想读取他的基础资料时使用这个接口。它会根据当前 token 的权限决定是否返回邮箱。

接口信息

项目内容
方法GET
路径/v2/users/:user_id
请求体
返回user
Scopeusers.read

权限要求

需要 users.read。如果当前 token 还具备 users.email.read,才会返回邮箱地址;没有这个 scope 时,person.emailnull

请求参数

参数类型必填说明
user_idstring用户 ID。

响应结果

{
  "object": "user",
  "id": "ffffffff-ffff-4fff-8fff-ffffffffffff",
  "type": "person",
  "name": "张三",
  "avatar_url": "https://example.com/avatar.png",
  "person": {
    "email": null
  }
}

person.email 是否有值取决于当前 token 是否具备 users.email.read

行为说明

  • 返回的是指定用户的基础资料,而不是当前 token 的身份。
  • 只有当前空间内可访问的用户才会返回成功结果。
  • 如果你没有 users.email.read,接口仍然可以成功,只是邮箱字段会被置为 null

错误提示

  • 401 unauthorized:token 无效或已过期。
  • 403 forbidden:缺少 users.read
  • 404 not_found:用户不存在,或不属于当前空间。

相关文档

前置阅读

下一步

相关参考