Skip to content

获取用户[列表]

  • 接口地址:/api/fresns/v1/user/list
  • 请求方式:GET
  • 传参方式:Query

Headers 可选参数

参数名公开模式(是否必传)私有模式(是否必传)
X-Fresns-AidNOYES
X-Fresns-Aid-TokenNOYES
X-Fresns-UidNOYES
X-Fresns-Uid-TokenNOYES

Query 参数

参数名类型是否必传说明
rolesStringNO指定主角色 rid,多个以英文逗号隔开
verifiedBooleanNO认证状态
genderNumberNO性别 gender 字段
1.未知 2.男 3.女 4.自定义
createdDaysNumberNO注册天数:指定天数内注册的用户
createdDateStringNO注册日期:today,yesterday,week,lastWeek,month,lastMonth,year,lastYear
createdDateGtStringNO注册时间大于 Y-m-d
createdDateLtStringNO注册时间小于 Y-m-d
viewCountGtNumberNO查看数大于
viewCountLtNumberNO查看数小于
likeCountGtNumberNO点赞数大于
likeCountLtNumberNO点赞数小于
dislikeCountGtNumberNO点踩数大于
dislikeCountLtNumberNO点踩数小于
followCountGtNumberNO关注数大于
followCountLtNumberNO关注数小于
blockCountGtNumberNO屏蔽数大于
blockCountLtNumberNO屏蔽数小于
postCountGtNumberNO发帖数大于
postCountLtNumberNO发帖数小于
commentCountGtNumberNO发评论数大于
commentCountLtNumberNO发评论数小于
postDigestCountGtNumberNO精华帖数大于
postDigestCountLtNumberNO精华帖数小于
commentDigestCountGtNumberNO精华评论数大于
commentDigestCountLtNumberNO精华评论数小于
extcredits1CountGtNumberNOextcredits1 大于
extcredits1CountLtNumberNOextcredits1 小于
extcredits2CountGtNumberNOextcredits2 大于
extcredits2CountLtNumberNOextcredits2 小于
extcredits3CountGtNumberNOextcredits3 大于
extcredits3CountLtNumberNOextcredits3 小于
extcredits4CountGtNumberNOextcredits4 大于
extcredits4CountLtNumberNOextcredits4 小于
extcredits5CountGtNumberNOextcredits5 大于
extcredits5CountLtNumberNOextcredits5 小于
orderTypeStringNO排序类型 createdTime,random,view,like,dislike,follow,block
post,comment,postDigest,commentDigest
extcredits1,extcredits2,extcredits3,extcredits4,extcredits5
默认 createdTime
orderDirectionStringNO排序方向,默认 desc
asc,desc
filterTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
filterKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
pageSizeNumberNO每页显示条数(默认 15 条)
pageNumberNO页码(默认 1)

返回结果

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / 一共有多少条数据",
            "pageSize": "Number / 每页有多少条数据",
            "currentPage": "Number / 当前页码",
            "lastPage": "Number / 最后一页页码"
        },
        "list": [
            {
                // 通用数据结构->用户信息
            }
        ]
    }
}

Released under the Apache-2.0 License