Skip to content

Group Categories

  • Endpoint Path: /api/v2/group/categories
  • Method: GET
  • Request: Query

Headers Optional Parameter

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

Query Params

Parameter NameTypeRequiredDescription
pageSizeNumberoptionalNumber of items per page (default 30 items)
pageNumberoptionalPage number (default 1)

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / How much data in total",
            "pageSize": "Number / How much data on each page",
            "currentPage": "Number / Current page number",
            "lastPage": "Number / Last page number"
        },
        "list": [
            {
                "gid": "String / Group category ID",
                "gname": "String / Group category name",
                "description": "String / Group category description",
                "cover": "String / Group category cover image URL",
                "banner": "String / Group category banner image URL"
            }
        ]
    }
}

Released under the Apache-2.0 License