获取清单任务列表

获取一个清单的任务列表，返回任务的摘要信息。

本接口支持分页。清单中的任务以“自定义拖拽”的顺序返回。

本接口支持简单的按照任务的完成状态或者任务的创建时间范围过滤。

分页参数说明：是否还有分页数据的判断依据是has_more=true，并非items个数，由于历史原因可能出现当前分页items为空情况。

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

请求

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

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
tasklist_guid	string	要获取任务的清单全局唯一ID 示例值："d300a75f-c56a-4be9-80d1-e47653028ceb"

查询参数

名称	类型	必填	描述
page_size	int	否	每页返回的任务数量 示例值：50 默认值：50 数据校验规则： - 取值范围：1 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：aWQ9NzEwMjMzMjMxMDE= 数据校验规则： - 最大长度：100 字符
completed	boolean	否	只查看特定完成状态的任务，填写“true”表示返回已经完成的任务；“false”表示只返回未完成的任务；不填写表示不按完成状态过滤。 示例值：true
created_from	string	否	任务创建的起始时间戳（ms），闭区间，不填写默认为首个任务的创建时间戳 示例值：1675742789470
created_to	string	否	任务创建的结束时间戳（ms），闭区间，不填写默认为最后创建任务的创建时间戳 示例值：1675742789470
user_id_type	string	否	用户 ID 类型 示例值：open_id 默认值：open_id

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	task_summary\[\]	任务摘要数据
└ guid	string	任务GUID
└ summary	string	任务标题
└ completed_at	string	任务完成的时间戳(ms)，为0表示未完成
└ start	start	任务开始时间
└ timestamp	string	开始时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果开始时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true
└ is_all_day	boolean	是否开始于一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。
└ due	due	任务截止时间
└ timestamp	string	截止时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果截止时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true
└ is_all_day	boolean	是否截止到一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。
└ members	member\[\]	任务成员列表
└ id	string	表示member的id
└ type	string	成员的类型
└ role	string	成员角色
└ name	string	成员名称
└ subtask_count	int	子任务的个数
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "guid": "e297ddff-06ca-4166-b917-4ce57cd3a7a0",
                "summary": "年终总结",
                "completed_at": "1675742789470",
                "start": {
                    "timestamp": "1675454764000",
                    "is_all_day": true
                },
                "due": {
                    "timestamp": "1675454764000",
                    "is_all_day": true
                },
                "members": [
                    {
                        "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                        "type": "user",
                        "role": "assignee",
                        "name": "张明德（明德）"
                    }
                ],
                "subtask_count": 1
            }
        ],
        "page_token": "aWQ9NzEwMjMzMjMxMDE=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1470400	The request parameter is incorrect, such as the tasklist GUID is invalid, or the page_size is a negative number, etc.	错误原因见返回的msg提示的信息。
404	1470404	The tasklist does not exist or has been deleted.	确认要获取任务列表的清单是否存在或已删除。
500	1470500	Server error.	尝试重试调用。如持续失败，请联系支持人员进行反馈。
403	1470403	Missing read permission for tasklist.	检查调用身份是否有清单的读取权限。详见清单是如何鉴权的？