Group Tree List
- Endpoint Path:
/api/v2/group/tree
- Method:
GET
Headers Optional Parameter
Parameter Name | 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
Parameter Name | Type | Required | Description |
---|---|---|---|
whitelistKeys | String | optional | 白名单键名,只返回给定键名的键值对 多个以英文逗号隔开,支持「点表示法」表示多维数组 |
blacklistKeys | String | optional | 黑名单键名,从返回数据中删除指定的键值对 多个以英文逗号隔开,支持「点表示法」表示多维数组 |
Request Description
- 本接口将获取全部小组,然后组装成树结构输出。
- 本接口使用场景类似于传统 BBS 版区,以树结构平铺所有小组(版区)。
Return
json
{
"code": 0,
"message": "ok",
"data": [
{
"gid": "String / 小组 ID",
"gname": "String / 小组名称",
"description": "String / 小组描述",
"cover": "String / 小组封面图地址",
"banner": "String / 小组条幅图地址",
"groups": [
{
// Common Data Structure -> Group Info
}
]
}
]
}