查询工作表

根据工作表 ID 查询工作表属性信息，包括工作表的标题、索引位置、是否被隐藏等。

前提条件

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

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:readonly 查看、评论和导出电子表格

请求头

名称	类型	必填	描述
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"
sheet_id	string	工作表的 ID。调用获取工作表获取 ID。 示例值："giDk9k"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ sheet	sheet	工作表
└ sheet_id	string	工作表 ID
└ title	string	工作表标题
└ index	int	工作表索引位置，索引从 0 开始计数。
└ hidden	boolean	工作表是否被隐藏 - true：被隐藏 - false：未被隐藏
└ grid_properties	grid_properties	单元格属性，仅当 resource_type 为 sheet 即工作表类型为电子表格时返回。
└ frozen_row_count	int	冻结的行数量
└ frozen_column_count	int	冻结的列数量
└ row_count	int	工作表的行数
└ column_count	int	工作表的列数量
└ resource_type	string	工作表类型 - sheet：工作表 - bitable：多维表格。详情参考多维表格概述 - #UNSUPPORTED_TYPE：不支持的类型
└ merges	merge_range\[\]	合并单元格的相关信息。没有合并单元格则不返回。
└ start_row_index	int	起始行，从 0 开始计数。
└ end_row_index	int	结束行，从 0 开始计数。
└ start_column_index	int	起始列，从 0 开始计数。
└ end_column_index	int	结束列，从 0 开始计数。

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "sheet": {
            "sheet_id": "sxj5ws",
            "title": "sheet1",
            "index": 0,
            "hidden": false,
            "grid_properties": {
                "frozen_row_count": 0,
                "frozen_column_count": 0,
                "row_count": 200,
                "column_count": 20
            },
            "resource_type": "sheet",
            "merges": [
                {
                    "start_row_index": 0,
                    "end_row_index": 0,
                    "start_column_index": 0,
                    "end_column_index": 0
                }
            ]
        }
    }
}

错误码

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