获取电子表格信息

GET

https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}

该接口用于获取电子表格的基础信息。

错误码

HTTP状态码	错误码	描述	排查建议
400	1310251	Invalid Parameter	参考响应体中的错误提示
400	1310213	Permission Fail	没有文档相应权限
400	1310249	Spreadsheet Deleted	恢复表格后重试
500	1315210	Server Error	服务内部错误，详询客服
500	1315203	Server Error	服务内部错误，详询客服
500	1315201	Server Error	服务内部错误，详询客服
400	1310214	SpreadSheet Not Found	检查表格 token

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/shtxxxxxxxxxxxxxxx' \
--header 'Authorization;'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "spreadsheet": {
            "title": "title",
            "owner_id": "ou_xxxxxxxxxxxx",
            "token": "shtxxxxxxxxxxxxxx",
            "url": "https://bytedance.feishu.cn/sheets/shtcnmBA*****yGehy8"
        }
    }
}

请求参数

Path 参数

spreadsheet_token

string

表格的token

必需

示例值:

shtxxxxxxxxxxxxxxx

Query 参数

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，字段权限要求：获取用户 user ID

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

spreadsheet

object

电子表格属性

必需

修改于 2023-01-13 09:55:58

修改电子表格属性

创建表格

获取电子表格信息

错误码#

请求参数

返回响应

错误码