Skip to main content
POST
查询知识列表

授权

app_key
string
query
必填

App key issued from the Flashduty console. Required on every public API call. Keep it secret — it grants the same access as the owning account.

请求体

application/json

知识列表的过滤与分页参数。

p
integer

页码,从 1 开始;p 与 limit 均未设置时返回全部结果。

limit
integer

每页条数。

scope
enum<string>

限定范围;all(默认)会覆盖 include_account。可选值:all(账户范围 + 可见团队范围)、account(仅账户级知识)、team(仅团队级知识,可配合 team_ids 过滤)。

可用选项:
all,
account,
team
query
string

对知识 ID、范围、范围 ID/账户 ID 和团队名称做大小写不敏感的子串过滤。

Maximum string length: 128
team_ids
integer<int64>[]

限定团队 ID;非管理员会与其所属团队取交集。

include_account
boolean | null

是否包含账户范围的知识;默认为 true。

响应

成功

Standard response envelope used by every Flashduty public API. On success data contains the endpoint-specific payload and error is absent. On failure error is present and data is absent. request_id is always present and is also mirrored in the Flashcat-Request-Id response header.

request_id
string
必填

本次请求的唯一 ID,与 Flashcat-Request-Id 响应头一致。反馈问题时请携带该 ID。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

响应结构中的错误 payload,仅在非 2xx 响应时出现。

data
object

可见的知识及过滤后的总数。