获取表格元数据

GET

/sheets/v2/spreadsheets/{spreadsheetToken}/metainfo

该接口用于根据 spreadsheetToken 获取表格元数据。
user_id_type目前默认值为lark_id，2022年1月26日后将会调整默认值为open_id，且不再支持lark_id，请尽快适配！
ownerUser字段已废弃，2022年1月26日后将不再返回ownerUser字段，请使用ownerUserID作为替代。ownerUserID为文档所有者的id，id类型由user_id_type决定。

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Query 参数

Body 参数text/plain

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/sheets/v2/spreadsheets//metainfo?extFields&user_id_type' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: text/plain' \
--data-raw 'curl --location --request GET '\''https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/metainfo?extFields=protectedRange&user_id_type=open_id'\'' \
--header '\''Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e'\'''

响应示例

{
    "code": 0,
    "msg": "Success",
    "data": {
        "properties": {
            "title": "",
            "ownerUser": 0,
            "sheetCount": 0,
            "revision": 0
        },
        "sheets": [
            {
                "sheetId": "***",
                "title": "***",
                "index": 0,
                "rowCount": 0,
                "columnCount": 0,
                "frozenColCount": 0,
                "frozenRowCount": 0,
                "merges": [
                    {
                        "columnCount": 0,
                        "rowCount": 0,
                        "startColumnIndex": 0,
                        "startRowIndex": 0
                    }
                ],
                "protectedRange": [
                    {
                        "dimension": {
                            "endIndex": 0,
                            "majorDimension": "ROWS",
                            "sheetId": "***",
                            "startIndex": 0
                        },
                        "protectId": "***",
                        "sheetId": "***",
                        "lockInfo": "***"
                    }
                ]
            },
            {
                "blockInfo": {
                    "blockToken": "***",
                    "blockType": "***"
                },
                "columnCount": 0,
                "frozenColCount": 0,
                "frozenRowCount": 0,
                "index": 0,
                "rowCount": 0,
                "sheetId": "***",
                "title": "*** "
            }
        ],
        "spreadsheetToken": "***"
    }
}

修改于 2025-10-21 06:21:34

创建表格

更新表格属性