Skip to content

获取清单详情

获取一个清单的详细信息,包括清单名,所有者,清单成员等。

Tip: 需要清单的读取权限。详情见清单功能概述中的“清单是如何鉴权的?“章节。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v2/tasklists/:tasklist_guid
HTTP MethodGET
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可task:tasklist:read 查看任务清单 task:tasklist:write 查看、创建、更新、删除任务清单

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
tasklist_guidstring清单全局唯一GUID
示例值:"d300a75f-c56a-4be9-80d1-e47653028ceb"

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
默认值open_id

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ tasklisttasklist清单详情
    └ guidstring清单的全局唯一ID
    └ namestring清单名
    └ creatormember清单创建者
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring清单角色
    └ ownermember清单所有者
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ membersmember\[\]清单协作成员
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ urlstring该清单分享的applink
    └ created_atstring清单创建时间戳(ms)
    └ updated_atstring清单最后一次更新时间戳(ms)

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "tasklist": {
            "guid": "cc371766-6584-cf50-a222-c22cd9055004",
            "name": "年会总结工作任务清单",
            "creator": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "creator"
            },
            "owner": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "owner"
            },
            "members": [
                {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "editor"
                }
            ],
            "url": "https://applink.feishu.cn/client/todo/task_list?guid=b45b360f-1961-4058-b338-7f50c96e1b52",
            "created_at": "1675742789470",
            "updated_at": "1675742789470"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4001470400请求参数错误,例如提供的清单GUID不合法。错误原因见返回的msg提示的信息。
4041470404清单不存在或者已删除。确认要获取的清单是否存在或已删除。
5001470500服务器错误。尝试重试调用。如持续失败,请联系支持人员进行反馈。
4031470403缺少清单读取权限。检查调用身份是否有清单的读取权限。详情见清单功能概述中的“清单是如何鉴权的?“章节。

内容来源:飞书开放平台 · 自动爬取整理