Description

Queries the detailed information of a given knowledge folder and returns the folder node data (including the current user's effective permission and whether visible sub-folders exist). Requires the current user to hold VIEW permission or above on the folder.

Request Specification

HTTP Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/knowledge/folder/detail?thirdTraceId=${Random String}

Request Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data
folderCode	String	Yes	Knowledge folder code; obtain it via List Visible Knowledge Folders

Request Example

{
  "data": {
    "folderCode": "16"
  }
}

Response Parameters

The response structure is identical to a single folder node (nodes[] item) of List Visible Knowledge Folders:

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error Codes
data	Map	Folder node data
folderCode	String	Knowledge folder code
name	String	Folder name
parentFolderCode	String	Parent folder code; null for top-level folders
level	Int	Folder hierarchy level (top level is 1)
categorySource	String	Folder source: UN_SYSTEM_INTEGRATION for folders created in-house or not linked to an external system; otherwise an integration source code (e.g. KnowledgeArticleObj, NetworkDisk, WebPage)
category_id	String	Associated category ID
pid	String	Parent category ID
space_id	String	ID of the space the folder actually belongs to
orderField	Int	Sort order within the same level
hasChildren	Boolean	Whether visible sub-folders exist for the current user
shortcut	Boolean	Whether in a shortcut expansion context; always false for this API
nodeType	String	Node type; always FOLDER for this API
permission	String	The current user's effective permission on the folder (VIEW or above); see Query Effective Permission of a Resource for values

Response Example

{
  "traceId": "E-O.fktest4234.1000-20260914122000-xxxxxx",
  "errorDescription": "success",
  "errorMessage": "success",
  "errorCode": 0,
  "data": {
    "folderCode": "16",
    "name": "Installation Guides",
    "parentFolderCode": null,
    "level": 1,
    "categorySource": "UN_SYSTEM_INTEGRATION",
    "category_id": "67f1xxxx",
    "pid": null,
    "space_id": "space-001",
    "orderField": 1,
    "hasChildren": true,
    "shortcut": false,
    "nodeType": "FOLDER",
    "permission": "VIEW"
  }
}

Notes

• If the folder does not exist, a "resource not found" failure is returned; if the folder exists but the current user lacks VIEW permission, a "permission denied" failure is returned — the two cases are distinguishable by error type.
• hasChildren counts only sub-folders visible (VIEW or above) to the current user; to enumerate them, drill down via List Visible Knowledge Folders.
• Do not use the message field in the response for logical judgment, as errorMessage may change.