服务端 API/云文档/电子表格/工作表/查询工作表
# 查询工作表

该接口用于通过工作表ID查询工作表属性信息。

## 请求

基本 |  
---|---
HTTP URL | https://open.larksuite.com/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id
HTTP Method | GET
接口频率限制 | [100 次/分钟](https://open.larksuite.com/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>查看、评论和下载云空间中所有文件(drive:drive:readonly)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、评论和导出电子表格(sheets:spreadsheet:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 路径参数

名称 | 类型 | 描述
---|---|---
spreadsheet_token | string | 表格的token，获取方式见[如何获取云文档资源相关 token](https://open.larksuite.com/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)<br>**示例值**："xxxxxxxxxxxxxxxxx"
sheet_id | string | 工作表的id，获取方式见[获取工作表](https://open.larksuite.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query)<br>**示例值**："giDk9k"

### 请求示例
```bash
curl --location --request GET 'https://open.larksuite.com/open-apis/sheets/v3/spreadsheets/shtcnmBA*****yGehy8/sheets/0354d1' \
--header 'Authorization: Bearer u-3iqkd6KWzRLzNdXfeuCMEb'
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
sheet | sheet | 工作表
sheet_id | string | 工作表id
title | string | 工作表标题
index | int | 工作表索引位置，索引从 0 开始计数。
hidden | boolean | 工作表是否被隐藏<br>- `true`：表示被隐藏<br>- `false`：表示未被隐藏
grid_properties | grid_properties | 单元格属性
frozen_row_count | int | 冻结的行数量
frozen_column_count | int | 冻结的列数量
row_count | int | 工作表的行数
column_count | int | 工作表的列数量
resource_type | string | 工作表类型<br>- `sheet`：工作表<br>- `bitable`：多维表格，[多维表格概述](https://open.larksuite.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)<br>- `#UNSUPPORTED_TYPE`：不支持的类型
merges | merge_range\[\] | 合并单元格的相关信息
start_row_index | int | 起始行
end_row_index | int | 结束行
start_column_index | int | 起始列
end_column_index | int | 结束列

### 响应体示例
```json
{
    "code": 0,
    "msg": "",
    "data": {
        "sheet": {
            "sheet_id": "sxj5ws",
            "title": "title",
            "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 | 没有文档相应权限
400 | 1310249 | Spreadsheet Deleted | 恢复表格后重试
400 | 1310214 | SpreadSheet Not Found | 检查表格 token
500 | 1315201 | Server Error | 服务内部错误，[详询客服](https://applink.larksuite.com/client/helpdesk/open?id=6626260912531570952)
500 | 1315203 | Server Error | 服务内部错误，[详询客服](https://applink.larksuite.com/client/helpdesk/open?id=6626260912531570952)
500 | 1315210 | Server Error | 服务内部错误，[详询客服](https://applink.larksuite.com/client/helpdesk/open?id=6626260912531570952)