跳转到主要内容
POST
查询模板列表

限制说明

使用说明

  • 第一页的第一条总是内置预设模板(template_id 为 6321aad26c12104586a88916),不受过滤条件影响,并计入 total。
  • 按 orderby(默认 created_at)排序,默认倒序,asc 为 true 时正序。已软删除的模板不返回。
  • is_my_team: true 时只返回调用方所在团队的模板;同时传了 team_ids 则只保留两者共有的团队。交集为空或调用方不属于任何团队时,返回空结果(total 为 0,也没有预设模板)。
  • query 是对 template_name 的正则匹配,不区分大小写;不合法的正则按普通文本匹配。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

分页过滤条件。默认 p=1、limit=20,limit 上限为 100。

p
integer
默认值:1

页码,从 1 开始。

必填范围: x >= 1
示例:

1

limit
integer
默认值:20

分页大小,最大 100。

必填范围: 1 <= x <= 100
示例:

20

orderby
enum<string>

排序字段:created_at(默认,创建时间)或 updated_at(最后更新时间)。

可用选项:
created_at,
updated_at
asc
boolean
默认值:false

为 true 时正序;默认最新的在前。

is_my_team
boolean
默认值:false

为 true 时只返回调用方所在团队的模板。同时传了 team_ids 时只保留两者共有的团队。两者没有共同团队,或调用方不属于任何团队时,返回空结果。

team_ids
integer<int64>[]

只返回这些团队 ID(可通过 POST /team/list 获取)的模板;0 表示账户级模板。为空或不传时不按团队过滤。与 is_my_team 的组合方式见该字段说明。

creator_id
integer<int64> | null

按创建人成员 ID 过滤,成员 ID 可通过 POST /member/list 获取。

query
string

对 template_name 做不区分大小写的正则匹配;不合法的正则按普通文本匹配。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

通知模板的分页列表。