开发工具

获取当前用户的文件列表

开发中

GET{endpoint_url}/files

在添加跨表格公式、合并工作表等操作时，选择用户最近使用的文件列表会请求此接口。

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Query 参数

limit

number

必需

文件列表最大条目数 ID

示例值:

123

orderBy

string

必需

文件列表按文件创建时间或最后修改时间排序，可选created_at、 updated_at

示例值:

created_at

Header 参数

X-Shimo-Token

string

必需

用于接入方对本次请求鉴权

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

array of:

string

必需

接入方系统中的文档 ID

name

string

文档标题

必需

type

string

必需

文档类型列表请参考创建文档，若为第三方存储的非石墨协作文件，则固定传 file

permissions

object

必需

请参考文件权限说明

commentable

boolean

必需

editable

boolean

必需

readable

boolean

必需

creatorId

string

必需

接入方文件的创建者用户 ID

createdAt

string

必需

接入方记录的文件创建时间，UTC 时间（0 时区），格式为 2022-01-01T09:00:01Z

updatedAt

string

必需

接入方记录的文件最后更新时间，UTC 时间（0 时区），格式为 2022-01-01T09:00:01Z

views

number

必需

接入方统计的文件阅读次数，用于在文档信息中展示阅读次数。若接入方未返回，则默认显示为 1

{
  "id": "ba13551165cc5066",
  "name": "示例文档.docx",
  "type": "file",
  "permissions": {
    "readable": true
  },
  "downloadUrl": "http://example.com/download/test.docx", // 文件预览时用到，协同文档留空
  "ext": "docx" // 若下载地址返回的 Content-Type 或 Content-Disposition 可识别则此字段可选
}

最后修改时间： 1 年前