查询所有任务

GET

/open-apis/task/v1/tasks

自建应用商店应用

以分页的方式获取任务列表。当使用user_access_token时，获取与该用户身份相关的所有任务。当使用tenant_access_token时，获取以该应用身份通过“创建任务“接口创建的所有任务（并非获取该应用所在租户下所有用户创建的任务）。本接口支持通过任务创建时间以及任务的完成状态对任务进行过滤。

错误码

HTTP状态码	错误码	描述	排查建议
403	1470403	The identity token is incorrect. It should be either user_access_token or tenant_access_token.	发起请求方的身份token不正确，需要为UserAccessToken或TenantAccessToken其中一种
500	1470605	failed to get task list	一般是系统内部错误造成的，可联系维护同学进行处理
400	1470421	page_size exceed 100	分页大小超过最大值100，需要减小page_size的值
400	1470422	failed to parse page_token	解析分页标识失败，需要检查分页标识是否合法

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/task/v1/tasks?page_size=10&page_token=MTYzMTg3ODUxNQ==&user_id_type=open_id&start_create_time=1652323335&end_create_time=false&task_completed=' \
--header 'Authorization;'

响应示例

{
  "code": 0,
  "data": {
    "has_more": true,
    "items": [
      {
        "can_edit": true,
        "collaborators": [
          {
            "id": "ou_842f5b9b4b8faa60570e9008acc9af1f"
          }
        ],
        "complete_time": "1637119864",
        "create_time": "1637045612",
        "creator_id": "ou_5df8b925054285f7166bf8b6ff03341f",
        "custom": "",
        "description": "多吃水果，多运动，健康生活，快乐工作。",
        "due": {
          "time": "1637137860",
          "timezone": "Asia/Shanghai"
        },
        "extra": "dGVzdA==",
        "followers": [
          {
            "id": "ou_842f5b9b4b8faa60570e9008acc9af1f"
          }
        ],
        "id": "11d42f77-cfa4-4833-a76e-ad778b081077",
        "origin": {
          "href": {
            "title": "反馈一个问题，需要协助排查",
            "url": "https://support.feishu.com/internal/foo-bar"
          },
          "platform_i18n_name": "{\"en_us\":\"IT Workspace\",\"zh_cn\":\"IT 工作台\"}"
        },
        "source": 6,
        "summary": "少喝咖啡",
        "update_time": "1637119866"
      },
      {
        "collaborators": [
          {
            "id": "ou_842f5b9b4b8faa60570e9008acc9af1f"
          }
        ],
        "complete_time": "1636965009",
        "create_time": "1632886899",
        "creator_id": "ou_5df8b925054285f7166bf8b6ff03341f",
        "custom": "",
        "description": "",
        "due": {
          "time": "0",
          "timezone": ""
        },
        "extra": "",
        "followers": [
          {
            "id": "ou_842f5b9b4b8faa60570e9008acc9af1f"
          }
        ],
        "id": "692ec13b-613d-4d0b-818d-a34ae2cb1413",
        "origin": {
          "href": {},
          "platform_i18n_name": "null"
        },
        "source": 1,
        "summary": "多喝热水",
        "update_time": "1636965011",
        "repeat_rule": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR"
      }
    ],
    "page_token": "MTYzMTg3ODUxNQ=="
  },
  "msg": ""
}

请求参数

Query 参数

page_size

string

可选

分页大小示例值：10 数据校验规则：最大值：100

示例值:

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："MTYzMTg3ODUxNQ=="

示例值:

MTYzMTg3ODUxNQ==

user_id_type

string

可选

用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

示例值:

open_id

start_create_time

string

可选

范围查询任务时，查询的起始时间。不填时默认起始时间为第一个任务的创建时间。

示例值:

1652323335

end_create_time

string

可选

可用于查询时过滤任务完成状态。true表示只返回已完成的任务，false表示只返回未完成的任务。不填时表示同时返回两种完成状态的任务。

示例值:

false

task_completed

string

可选

用户 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，字段权限要求：

获取用户 user ID

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

data

object

必需

has_more

boolean

必需

items

array [object {16}]

任务列表

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

msg

string

错误描述

必需

修改于 2023-02-02 07:58:08

查询指定任务

功能介绍

查询所有任务

错误码#

请求参数

返回响应

错误码