开发工具
  1. 文件信息
开发工具
  • 文档专区
    • 10 分钟创建协同文档
    • 签名续期说明
    • 签名方式
    • 用户席位说明
  • 石墨API 接口
    • App 管理
      • 获取 App 详情
      • 更新 App 回调地址
      • 获取用户列表和席位状态
      • 激活用户席位​
      • 取消用户席位​
      • 批量设置用户席位
    • 文档创建删除
      • 创建协同文档
      • 创建协同文档副本
      • 删除协同文档
      • 访问预览文档
      • 创建预览文档
    • 文档导入导出
      • 导入文件
      • 获取导入进度
      • 导出文件
      • 获取导出进度
      • 导出应用表格为Excel
    • 文档操作
      • 通用
        • 获取文件纯文本内容
        • 文件纯文本字数统计
        • 获取历史列表
        • 获取版本列表
        • 获取文档内容中所有的at人信息列表
      • 表格(Excel)
        • 获取表格内容
        • 获取文档中的评论数
        • 更新表格内容
        • 追加表格内容
        • 删除表格行
        • 新增表格工作表
      • 传统文档(Word)
        • 读取传统文档书签内容
        • 替换传统文档书签内容
  • 接入方实现接口(回调接口)
    • 文件信息
      • 获取文件元信息-协同文档
        GET
      • 获取文件元信息-预览文档
        GET
      • 获取当前用户的文件列表
        GET
      • 获取文件的协作者列表
        GET
      • 获取接入方指定文件的完整访问地址
        POST
      • 获取文件元信息-协同文档自动任务
        GET
      • 根据指定用户获取文件元信息-协同文档
        GET
    • 用户信息
      • 获取当前用户信息
      • 获取当前用户所在团队信息
      • 获取指定用户信息
      • 获取用户水印信息
      • 获取用户部门路径
      • 批量获取用户信息
    • 团队和部门
      • 获取团队下的成员列表
      • 获取部门信息
      • 获取部门的下级部门节点
      • 获取部门下的成员分页列表
    • 搜索功能
      • 获取与文件相关的用户列表
      • 获取与文件相关的文件列表
      • 按关键字搜索文件和用户列表
    • 消息推送
      • 评论
        • 轻文档
          • 添加评论
          • 删除评论
          • 结束评论
        • 表格
          • 添加评论
          • 删除评论
          • 结束评论
        • 传统文档
          • 添加评论
          • 删除评论
          • 更新评论
        • 幻灯片
          • 添加评论
          • 删除评论
          • 结束评论
        • 应用表格
          • 添加评论
          • 对于评论的回复评论
          • 删除评论
      • 讨论(Discussion)
        • 轻文档
          • 发送讨论消息
      • 提及(MentionAt @ 人)
        • 轻文档
          • 在评论中 at
          • 在讨论中 at
          • 在正文中 at
        • 表格
          • 在评论中 at
          • 在正文中 at
        • 传统文档
          • 在评论中 at
          • 在正文中 at
        • 应用表格
          • 在评论中 at
          • 在正文中 at
      • 日期提醒 (DateMention)
        • 轻文档
          • 创建
          • 修改
          • 删除
        • 表格
          • 创建
          • 修改
          • 删除
        • 传统文档
          • 创建
          • 修改
          • 删除
      • 文件内容更新 (FileContent)
        • 文件内容更新
      • 文档协作者协同状态变化 (Collaborator)
        • 文档协作者协同状态变化
      • 版本 (Revision)
        • 版本
      • 系统事件 (System)
        • 系统事件
      • (实验性) 回调请求错误
        • 回调请求错误
  1. 文件信息

获取当前用户的文件列表

开发中
GET
{endpoint_url}/files
在添加跨表格公式、合并工作表等操作时,选择用户最近使用的文件列表会请求此接口。

请求参数

Path 参数
endpoint_url
string 
必需
示例值:
{{ endpoint_url}}
Query 参数
limit
number 
必需
文件列表最大条目数 ID
示例值:
123
orderBy
string 
必需
文件列表按文件创建时间或最后修改时间排序,可选created_at、 updated_at
示例值:
created_at
Header 参数
X-Shimo-Token
string 
必需
用于接入方对本次请求鉴权

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{ endpoint_url}}/files?limit=123&orderBy=created_at' \
--header 'X-Shimo-Token;'

返回响应

🟢200成功
application/json
Body
array of:
id
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 可识别则此字段可选
}
上一页
获取文件元信息-预览文档
下一页
获取文件的协作者列表
Built with