# 搜索清单
通过清单关键词搜索清单的信息，包括清单名称、清单ID、清单链接、清单描述
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/task/v2/tasklists/search
HTTP Method | POST
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查看任务清单(task:tasklist:read)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
page_size | int | 否 | 一页获取的清单个数，最小值1，默认值15，最大值30
**示例值**：10
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
**示例值**：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly)
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
query | string | 否 | query
**示例值**："测试任务清单"
**数据校验规则**：
- 长度范围：`0` ～ `50` 字符
filter | tasklist_search_filter | 否 | 过滤参数，包括创建时间，创建人，不设置时不过滤
create_time | time_range | 否 | 清单的创建时间，start_time应该小于end_time
start_time | string | 否 | 范围内的起始时间 (ISO 8601)
**示例值**："2026-03-21T16:15:30+08:00"
**数据校验规则**：
- 长度范围：`0` ～ `32` 字符
- 正则校验：`^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(Z|([+-](?:[01]\d|2[0-3]):?[0-5]\d))$`
end_time | string | 否 | 范围内的结束时间 (ISO 8601)
**示例值**："2026-03-21T16:15:30+08:00"
**数据校验规则**：
- 长度范围：`0` ～ `32` 字符
- 正则校验：`^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(Z|([+-](?:[01]\d|2[0-3]):?[0-5]\d))$`
user_id | string\[\] | 否 | 创建人 IDs，与 user_id_type 类型一致
**示例值**：["ou_7890123456abcdef"]
**数据校验规则**：
- 长度范围：`0` ～ `500`
### 请求体示例
```json
{
"query": "测试任务清单",
"filter": {
"create_time": {
"start_time": "2026-03-21T16:15:30+08:00",
"end_time": "2026-03-21T16:15:30+08:00"
},
"user_id": [
"ou_7890123456abcdef"
]
}
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | tasklist_search_item\[\] | items
id | string | 任务清单 ID
display_info | string | 包含任务清单基本信息的卡片，用户搜索关键词命中的文本片段，使用标签包裹标注
meta_data | tasklist_search_meta | 任务清单元信息
app_link | string | 任务清单的 AppLink
avatar | string | 任务清单头像
description | string | 任务清单描述
total | int | total
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "123456789",
"display_info": "任务清单搜索",
"meta_data": {
"app_link": "https://applink.feishu.cn/client/todo/detail?guid=ed03112a-0a25-451e-8453-ba1d80cc1b7e",
"avatar": "https://p3-lark-file.byteimg.com/img/lark-avatar-staging/default-avatar_44ae0ca3-e140-494b-956f-78091e348435~100x100.jpg",
"description": "这是一个用来测试的任务清单"
}
}
],
"total": 10,
"has_more": true,
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1474001 | invalid param: missing required fields | 检查是否缺少必填参数