Skip to content

获取执行者列表

该接口用于查询任务执行者列表,支持分页,最大值为50。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v1/tasks/:task_id/collaborators
HTTP MethodGET
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可task:task 查看、创建、编辑和删除任务(旧版) task:task:readonly 查看任务详情
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称类型描述
task_idstring任务 ID
示例值:"0d38e26e-190a-49e9-93a2-35067763ed1f"

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:50
默认值50
数据校验规则
- 取值范围:050
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:「上次返回的page_token」
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemscollaborator\[\]返回的执行者ID列表
    └ idstring任务执行者的 ID。 传入的值为 user_id 或 open_id,由user_id_type 决定。user_id和open_id的获取可见文档如何获取不同的用户 ID
> Info: 已经废弃,为了向前兼容早期只支持单次添加一个人的情况而保留,但不再推荐使用,建议使用id_list字段
    └ id_liststring\[\]执行者的用户ID列表。 传入的值为 user_id 或 open_id,由user_id_type 决定。user_id和open_id的获取可见文档如何获取不同的用户 ID
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "ou_99e1a581b36ecc4862cbfbce473f1234",
                "id_list": [
                    "ou_99e1a581b36ecc4862cbfbce473f3123"
                ]
            }
        ],
        "page_token": "「上次返回的page_token」",
        "has_more": false
    }
}

错误码

HTTP状态码错误码描述排查建议
4031470403The identity token is incorrect. It should be either user_access_token or tenant_access_token.发起请求方的身份token不正确,需要为UserAccessToken或TenantAccessToken其中一种
4001470602Invalid task id.请检查任务的 id 是否合法
4001470432have no permission to get task没有获取任务的权限,需要检查当前发起请求的对象是否有权限

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