获取自定义分组列表

获取一个资源下所有的自定义分组列表。支持分页。返回结果按照自定义分组在界面上的顺序排序。

Tip: 获取自定义分组列表需要资源的读取权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/task/v2/sections
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

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：50 默认值：50 数据校验规则： - 取值范围：1 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：aWQ9NzEwMjMzMjMxMDE= 数据校验规则： - 最大长度：100 字符
resource_type	string	是	自定义分组所属的资源类型。支持my_tasks(我负责的）和tasklist（清单）。当使用tasklist时，需要用resource_id提供清单的全局唯一ID。 示例值：tasklist 数据校验规则： - 最大长度：100 字符
resource_id	string	否	如resource_type为"tasklist"，这里需要填写要列取自定义分组的清单的GUID。 示例值：caef228f-2342-23c1-c36d-91186414dc64 数据校验规则： - 最大长度：100 字符
user_id_type	string	否	用户 ID 类型 示例值：open_id 默认值：open_id

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	section_summary\[\]	自定义分组的摘要列表
└ guid	string	自定义分组的全局唯一ID
└ name	string	自定义分组的名称
└ is_default	boolean	是否是默认分组
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "guid": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2",
                "name": "审核过的任务",
                "is_default": true
            }
        ],
        "page_token": "aWQ9NzEwMjMzMjMxMDE=",
        "has_more": true
    }
}

错误码

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