Skip to content

Group Tree List

  • Endpoint Path: /api/fresns/v1/group/tree
  • Method: GET
  • Request: Query

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Query Params

KeyTypeRequiredDescription
filterTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
filterKeysStringoptionalMultiple 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
                }
            ]
        }
    ]
}

Released under the Apache-2.0 License