列取自定义分组中的任务

列取一个自定义分组里的所有任务。支持分页。任务按照自定义排序的顺序返回。本接口支持简单的过滤。

Tip: 需要自定义分组所在资源的读取权限。

请求

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

请求头

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

路径参数

名称	类型	描述
section_guid	string	要获取任务的自定义分组全局唯一ID 示例值："9842501a-9f47-4ff5-a622-d319eeecb97f"

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：50 默认值：50 数据校验规则： - 取值范围：1 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：aWQ9NzEwMjMzMjMxMDE=
completed	boolean	否	按照任务状态过滤，如果不填写则表示不按完成状态过滤 示例值：true
created_from	string	否	按照创建时间筛选的起始时间戳（ms)，如不填写则为首个任务的创建时刻 示例值：1675742789470 数据校验规则： - 最大长度：30 字符
created_to	string	否	按照创建时间筛选的起始时间戳（ms)，如不填写则为最后任务的创建时刻 示例值：1675742789470 数据校验规则： - 最大长度：30 字符

响应

响应体

名称	类型	描述
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	成员角色
└ 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": "editor"
                    }
                ],
                "subtask_count": 1
            }
        ],
        "page_token": "aWQ9NzEwMjMzMjMxMDE=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1470400	请求参数错误，如提供的section_guid不合法。	错误原因见返回的msg提示的信息。
404	1470404	要访问的自定义分组不存在或已删除。	确定要访问的自定义分组不存在或已删除。
500	1470500	服务器错误。	尝试重试调用。如持续失败，请联系支持人员进行反馈。
403	1470403	缺少获取自定义分组下任务列表的权限。	确认调用身份拥有获取自定义分组归属资源的读取权限。