Skip to content

Group List

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

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)

Query Params

Parameter NameTypeRequiredDescription
gidStringoptionalGet groups under this gid
recommendBooleanoptionalRecommendation status 0. Not recommended / 1. Recommended
createdDaysNumberoptionalDays created: Group created in the specified number of days
createdDateStringoptionalDate created: today,yesterday,week,lastWeek,month,lastMonth,year,lastYear
createdDateGtStringoptionalCreated date greater than Y-m-d
createdDateLtStringoptionalCreated date less than Y-m-d
viewCountGtNumberoptionalView count greater than
viewCountLtNumberoptionalView count less than
likeCountGtNumberoptionalLikes count greater than
likeCountLtNumberoptionalLikes count less than
dislikeCountGtNumberoptionalDislikes count greater than
dislikeCountLtNumberoptionalDislikes count less than
followCountGtNumberoptionalFollows count greater than
followCountLtNumberoptionalFollows count less than
blockCountGtNumberoptionalBlock count greater than
blockCountLtNumberoptionalBlock count less than
postCountGtNumberoptionalTotal number of posts greater than
postCountLtNumberoptionalTotal number of posts less than
postDigestCountGtNumberoptionalTotal number of digest posts greater than
postDigestCountLtNumberoptionalTotal number of digest posts less than
orderTypeStringoptionalSort by type: view,like,random,dislike,follow,block,post,postDigest,createdTime,rating
Default rating
orderDirectionStringoptionalSort by direction asc,desc, Default: asc
whitelistKeysStringoptionalWhitelist key names, only returns key-value pairs for the given key names
Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays
blacklistKeysStringoptionalBlacklist key names, removes specified key-value pairs from the returned data
Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays
pageSizeNumberoptionalNumber of items per page (default 15 items)
pageNumberoptionalPage number (default 1)


    "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": [
                // Common Data Structure -> Group Info

Released under the Apache-2.0 License