Skip to main content
POST
List knowledge

Restrictions

Usage

  • Returns the account knowledge plus the knowledge of teams the caller belongs to. This applies to every caller — owners and admins do not see knowledge of teams they have not joined.
  • The account knowledge appears only after it has been created (by POST /safari/knowledge/get, a file call without pack_id, or POST /safari/knowledge/pack/ensure); this endpoint does not create it.
  • query filters first, then p/limit page the filtered result; total is the count after filtering. Omit both p and limit to get everything.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Filter and pagination for the knowledge list.

p
integer

Page number, 1-based. When both p and limit are omitted (or ≤ 0), all matching knowledge is returned without paging; when only limit is set, p defaults to 1.

limit
integer

Page size. Defaults to 20 when p is set and limit is omitted; no upper bound is enforced.

scope
enum<string>

Which scopes to return:

  • all (default): account knowledge (unless include_account is false) plus the visible team knowledge.
  • account: only the account knowledge; include_account and team_ids are ignored.
  • team: only team knowledge, optionally narrowed by team_ids; include_account is ignored.
Available options:
all,
account,
team
query
string

Case-insensitive substring filter over knowledge ID, scope, scope ID, account ID and team name. Account knowledge also matches 账户/账号 and team knowledge also matches 团队. Leading and trailing spaces are ignored.

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

Restrict team knowledge to these team IDs. IDs of teams the caller does not belong to are silently dropped — this applies to every caller, including owners and admins.

include_account
boolean | null

Whether to include the account knowledge when scope is all or omitted. Defaults to true.

Response

Success

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
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

Error payload inside the response envelope. Present only on non-2xx responses.

data
object

Visible knowledge and the total after filtering.