Group Tree List
- Endpoint Path:
/api/fresns/v1/group/tree
- Method:
GET
- Request:
Query
Headers Optional Parameter
Key | Public Mode (Required) | Private Mode (Required) |
---|---|---|
X-Fresns-Aid | optional | required |
X-Fresns-Aid-Token | optional | required |
X-Fresns-Uid | optional | required |
X-Fresns-Uid-Token | optional | required |
Query Params
Key | Type | Required | Description |
---|---|---|---|
type | Number | optional | Specify custom type |
filterType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned data |
filterKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
Request Description
- This interface will fetch all groups and then assemble them into a tree structure for output.
- This interface is not available if the total number of groups exceeds 100.
- The use case of this interface is similar to traditional BBS sections, where all groups (sections) are displayed in a tree structure.
Return
json
{
"code": 0,
"message": "ok",
"data": [
{
// Common Data Structure -> Group Info
"groups": [
{
// Common Data Structure -> Group Info
}
]
}
]
}