Skip to content

User List

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

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)

Query Params

Parameter NameTypeRequiredDescription
rolesStringoptionalSpecify main role rid, separated by commas for multiple values
verifiedBooleanoptionalVerification status
genderNumberoptionalgender field
1 Not set / 2 Male / 3 Female
createdDaysNumberoptionalDays register: User register in the specified number of days
createdDateStringoptionalDate register: today,yesterday,week,lastWeek,month,lastMonth,year,lastYear
createdDateGtStringoptionalRegister date greater than Y-m-d
createdDateLtStringoptionalRegister 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
commentCountGtNumberoptionalTotal number of comments greater than
commentCountLtNumberoptionalTotal number of comments less than
postDigestCountGtNumberoptionalTotal number of digest posts greater than
postDigestCountLtNumberoptionalTotal number of digest posts less than
commentDigestCountGtNumberoptionalTotal number of digest comments greater than
commentDigestCountLtNumberoptionalTotal number of digest comments less than
extcredits1CountGtNumberoptionalextcredits1 greater than
extcredits1CountLtNumberoptionalextcredits1 less than
extcredits2CountGtNumberoptionalextcredits2 greater than
extcredits2CountLtNumberoptionalextcredits2 less than
extcredits3CountGtNumberoptionalextcredits3 greater than
extcredits3CountLtNumberoptionalextcredits3 less than
extcredits4CountGtNumberoptionalextcredits4 greater than
extcredits4CountLtNumberoptionalextcredits4 less than
extcredits5CountGtNumberoptionalextcredits5 greater than
extcredits5CountLtNumberoptionalextcredits5 less than
orderTypeStringoptionalSort by type: createdTime,random,view,like,dislike,follow,block
Default createdTime
orderDirectionStringoptionalSort by direction, default desc
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 -> User Info

Released under the Apache-2.0 License