获取企业信息
获取企业名称、企业编号等企业信息
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/tenant/v2/tenant/query |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | tenant:tenant:readonly 获取企业信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 tenant:tenant.domain:read 获取企业完整域名 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ tenant | tenant | 企业信息 |
└ name | string | 企业名称 |
└ display_id | string | 企业编号,平台内唯一 |
└ tenant_tag | int | 个人版/团队版标志 可选值有: - 0: 团队版 - 2: 个人版 |
└ tenant_key | string | 企业标识 |
└ avatar | avatar | 企业头像 |
└ avatar_origin | string | 企业头像 |
└ avatar_72 | string | 企业头像 72x72 |
└ avatar_240 | string | 企业头像 240x240 |
└ avatar_640 | string | 企业头像 640x640 |
└ domain | string | 企业完整域名。企业域名可用于企业成员访问管理后台、云文档等含URL地址的网页。 字段权限要求: tenant:tenant.domain:read 获取企业完整域名 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"tenant": {
"name": "企业名称",
"display_id": "F123456789",
"tenant_tag": 0,
"tenant_key": "abcdefghi",
"avatar": {
"avatar_origin": "https://foo.icon.com/xxxx",
"avatar_72": "https://foo.icon.com/xxxx",
"avatar_240": "https://foo.icon.com/xxxx",
"avatar_640": "https://foo.icon.com/xxxx"
},
"domain": "example.feishu.cn"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 404 | 1184000 | 企业不存在 | 确认tenant_access_key是否正确 |
| 403 | 1184001 | 无权限获取企业信息 | 如果ISV应用是预装的并且180天内企业未使用过此应用,则无法通过此接口获取到企业信息 |
