获取电子表格信息

根据电子表格 token 获取电子表格的基础信息，包括电子表格的所有者、URL 链接等。

前提条件

调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有电子表格的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考如何为应用或用户开通文档权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:readonly 查看、评论和导出电子表格
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称	类型	描述
spreadsheet_token	string	电子表格的 token。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 示例值："Iow7sNNEphp3WbtnbCscPqabcef"

查询参数

名称	类型	必填	描述
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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ spreadsheet	get_spreadsheet	电子表格的基础信息
└ title	string	电子表格标题
└ owner_id	string	电子表格的所有者 ID。ID 类型由查询参数 user_id_type 决定。
└ token	string	电子表格 token
└ url	string	电子表格的 URL 链接

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "spreadsheet": {
            "title": "title",
            "owner_id": "ou_48d0958ee4b2ab3eaf0b5f6c968abcef",
            "token": "Iow7sNNEphp3WbtnbCscPqabcef",
            "url": "https://example.feishu.cn/sheets/Iow7sNNEphp3WbtnbCscPqabcef"
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1310251	Invalid Parameter	参考响应体中的错误提示
400	1310213	Permission Fail	当前调用身份没有电子表格的阅读（获取相关接口）或编辑（创建、更新等相关接口）权限。请参考以下方式解决： - 如果你使用的是 tenant_access_token，意味着当前应用没有电子表格的阅读或编辑权限。你需通过电子表格网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加权限。 说明：在 添加文档应用 前，你需确保目标应用至少开通了一个云文档 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 如果你使用的是 user_access_token，意味着当前用户没有电子表格的阅读或编辑权限。你需通过电子表格网页页面右上方 分享 入口为当前用户添加权限。 了解具体操作步骤或其它添加权限方式，参考云文档常见问题 3。
400	1310249	Spreadsheet Deleted	当前电子表格已删除。请恢复表格后重试
500	1315210	Server Error	服务内部错误，详询客服
500	1315203	Server Error	服务内部错误，详询客服
500	1315201	Server Error	服务内部错误，详询客服
400	1310214	SpreadSheet Not Found	检查表格 token