Skip to content

获取自定义分组详情

获取一个自定义分组详情,包括名称,创建人等信息。如果该自定义分组归属于一个清单,还会返回清单的摘要信息。

Tip: 需要清单归属资源的读取权限。

请求

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

请求头

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

路径参数

名称类型描述
section_guidstring要获取的自定义分组GUID
示例值:"9842501a-9f47-4ff5-a622-d319eeecb97f"
数据校验规则
- 最大长度:100 字符

查询参数

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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ sectionsection获取的自定义分组详情
    └ guidstring自定义分组的GUID
    └ namestring自定义分组的名字
    └ resource_typestring资源类型
    └ is_defaultboolean分组是否为默认自定义分组
    └ creatormember自定义分组的创建者
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ tasklisttasklist_summary如果该分组归属于清单,展示清单的简要信息
      └ guidstring清单GUID
      └ namestring清单名字
    └ created_atstring自定义分组创建时间戳(ms)
    └ updated_atstring自定义分组最近一次更新时间戳(ms)

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "section": {
            "guid": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2",
            "name": "已经评审过的任务",
            "resource_type": "tasklist",
            "is_default": true,
            "creator": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "creator"
            },
            "tasklist": {
                "guid": "cc371766-6584-cf50-a222-c22cd9055004",
                "name": "活动分工任务列表"
            },
            "created_at": "1675742789470",
            "updated_at": "1675742789470"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4001470400请求参数有误,如传入的section_guid不合法。具体错误原因参考返回的msg提示的错误信息。
4041470404要获取的自定义分组不存在或已删除。确认自定义分组不存在或已删除。
5001470500服务器错误。尝试重试调用。如持续失败,请联系支持人员进行反馈。
4031470403缺少访问自定义分组的权限。确认调用身份拥有访问自定义分组的权限。

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