获取用户列表

请求参数

Query 参数

roles

string

可选

指定主角色，多个以英文逗号隔开

verified

integer

认证状态

可选

gender

number

可选

性别 gender 字段
1 未设置 / 2 男 / 3 女

createDate

string

可选

注册日期：today,yesterday,week,lastWeek,month,lastMonth,year,lastYear

createDateGt

string

可选

注册时间大于?Y-m-d

createDateLt

string

可选

注册时间小于?Y-m-d

likeCountGt

number

点赞数大于

可选

likeCountLt

number

点赞数小于

可选

dislikeCountGt

number

点踩数大于

可选

dislikeCountLt

number

点踩数小于

可选

followCountGt

number

关注数大于

可选

followCountLt

number

关注数小于

可选

blockCountGt

number

屏蔽数大于

可选

blockCountLt

number

屏蔽数小于

可选

postCountGt

number

发帖数大于

可选

postCountLt

number

发帖数小于

可选

commentCountGt

number

发评论数大于

可选

commentCountLt

number

发评论数小于

可选

postDigestCountGt

number

精华帖数大于

可选

postDigestCountLt

number

精华帖数小于

可选

commentDigestCountGt

number

精华评论数大于

可选

commentDigestCountLt

number

精华评论数小于

可选

extcredits1CountGt

number

可选

extcredits1 大于

extcredits1CountLt

number

可选

extcredits1 小于

extcredits2CountGt

number

可选

extcredits2 大于

extcredits2CountLt

number

可选

extcredits2 小于

extcredits3CountGt

number

可选

extcredits3 大于

extcredits3CountLt

number

可选

extcredits3 小于

extcredits4CountGt

number

可选

extcredits4 大于

extcredits4CountLt

number

可选

extcredits4 小于

extcredits5CountGt

number

可选

extcredits5 大于

extcredits5CountLt

number

可选

extcredits5 小于

orderType

string

可选

排序类型，默认 createDate
createDate,like,dislike,follow,block
post,comment,postDigest,commentDigest
extcredits1,extcredits2,extcredits3,extcredits4,extcredits5

orderDirection

string

可选

排序方向，默认 desc
asc,desc

whitelistKeys

string

可选

白名单键名，只返回给定键名的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组

blacklistKeys

string

可选

黑名单键名，从返回数据中删除指定的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组

pageSize

number

可选

每页显示条数（默认 15 条）

page

number

页码（默认 1）

可选

Header 参数

X-Fresns-App-Id

string

必需

密钥 App ID
密钥位置：控制面板->应用中心->应用密钥

默认值:

X-Fresns-Client-Platform-Id

integer

必需

平台编号，与密钥的「平台」匹配

默认值:

X-Fresns-Client-Version

string

必需

你的客户端版本号，推荐使用语义化版本号

默认值:

X-Fresns-Client-Device-Info

string

必需

交互设备信息 session_logs > device_info
压缩 Object 信息为字符串传参

默认值:

X-Fresns-Aid

string

可选

账号参数（留空则视为未登录账号）

默认值:

X-Fresns-Aid-Token

string

可选

账号身份凭证（传参 aid 时必传）

默认值:

X-Fresns-Uid

integer

可选

用户参数（留空则视为未登录用户）

默认值:

X-Fresns-Uid-Token

string

可选

用户身份凭证（传参 uid 时必传）

默认值:

X-Fresns-Signature

string

签名

必需

X-Fresns-Signature-Timestamp

string

必需

签名生成时间（当前 Unix 时间戳，精确到秒或毫秒都支持）

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

paginate

object

必需

list

array [object {49}]

必需

示例

{
  "code": 0,
  "message": "成功",
  "data": {
    "paginate": {
      "total": 2,
      "pageSize": 15,
      "currentPage": 1,
      "lastPage": 1
    },
    "list": [
      {
        "fsid": "UK1IPBVI",
        "uid": 20422,
        "username": "UK1IPBVI",
        "url": "/u/UK1IPBVI",
        "nickname": "赵勇",
        "avatar": "http://localhost:8080/static/images/default-avatar.png",
        "decorate": null,
        "banner": null,
        "gender": 1,
        "birthday": null,
        "bio": null,
        "location": null,
        "conversationLimit": 1,
        "commentLimit": 1,
        "timezone": "+8",
        "verifiedStatus": false,
        "verifiedIcon": null,
        "verifiedDesc": null,
        "verifiedDateTime": null,
        "expired": false,
        "expiryDateTime": null,
        "lastPublishPost": null,
        "lastPublishComment": null,
        "lastEditUsername": null,
        "lastEditNickname": null,
        "registerDate": "2023-03-22 17:41:45",
        "hasPassword": false,
        "rankState": 1,
        "status": true,
        "waitDelete": false,
        "waitDeleteDateTime": null,
        "bioHtml": "",
        "nicknameColor": null,
        "rid": 4,
        "roleName": "普通会员",
        "roleNameDisplay": false,
        "roleIcon": null,
        "roleIconDisplay": false,
        "roleExpiryDateTime": null,
        "roleRankState": 1,
        "rolePermissions": {
          "rid": 4,
          "content_view": true,
          "conversation": true,
          "content_link_handle": 2,
          "post_publish": true,
          "post_review": false,
          "post_email_verify": false,
          "post_phone_verify": false,
          "post_real_name_verify": false,
          "post_limit_status": false,
          "post_limit_type": 1,
          "post_limit_period_start": "2022-06-01 22:30:00",
          "post_limit_period_end": "2022-06-06 08:00:00",
          "post_limit_cycle_start": "23:00:00",
          "post_limit_cycle_end": "08:30:00",
          "post_limit_rule": 1,
          "post_second_interval": 60,
          "post_draft_count": 10,
          "comment_publish": true,
          "comment_review": false,
          "comment_email_verify": false,
          "comment_phone_verify": false,
          "comment_real_name_verify": false,
          "comment_limit_status": false,
          "comment_limit_type": 1,
          "comment_limit_period_start": "2022-06-01 22:30:00",
          "comment_limit_period_end": "2022-06-06 08:00:00",
          "comment_limit_cycle_start": "23:00:00",
          "comment_limit_cycle_end": "08:30:00",
          "comment_limit_rule": 1,
          "comment_second_interval": 60,
          "comment_draft_count": 10,
          "post_editor_image": true,
          "post_editor_image_upload_number": 9,
          "post_editor_video": true,
          "post_editor_video_upload_number": 1,
          "post_editor_audio": true,
          "post_editor_audio_upload_number": 2,
          "post_editor_document": true,
          "post_editor_document_upload_number": 10,
          "comment_editor_image": true,
          "comment_editor_image_upload_number": 9,
          "comment_editor_video": false,
          "comment_editor_video_upload_number": 1,
          "comment_editor_audio": false,
          "comment_editor_audio_upload_number": 2,
          "comment_editor_document": false,
          "comment_editor_document_upload_number": 10,
          "image_max_size": 5,
          "video_max_size": 50,
          "video_max_time": 60,
          "audio_max_size": 50,
          "audio_max_time": 60,
          "document_max_size": 10,
          "follow_user_max_count": 500,
          "block_user_max_count": 500,
          "download_file_count": 10
        },
        "roleStatus": true,
        "stats": {
          "likeUserCount": null,
          "likeGroupCount": null,
          "likeHashtagCount": null,
          "likePostCount": null,
          "likeCommentCount": null,
          "dislikeUserCount": null,
          "dislikeGroupCount": null,
          "dislikeHashtagCount": null,
          "dislikePostCount": null,
          "dislikeCommentCount": null,
          "followUserCount": 0,
          "followGroupCount": 0,
          "followHashtagCount": null,
          "followPostCount": null,
          "followCommentCount": null,
          "blockUserCount": null,
          "blockGroupCount": null,
          "blockHashtagCount": null,
          "blockPostCount": null,
          "blockCommentCount": null,
          "likeMeCount": 0,
          "dislikeMeCount": null,
          "followMeCount": 0,
          "blockMeCount": null,
          "postPublishCount": 0,
          "postDigestCount": 0,
          "postLikeCount": 0,
          "postDislikeCount": null,
          "postFollowCount": 0,
          "postBlockCount": null,
          "commentPublishCount": 0,
          "commentDigestCount": 0,
          "commentLikeCount": 0,
          "commentDislikeCount": null,
          "commentFollowCount": 0,
          "commentBlockCount": null,
          "extcredits1": null,
          "extcredits1Status": 1,
          "extcredits1Name": null,
          "extcredits1Unit": null,
          "extcredits2": null,
          "extcredits2Status": 1,
          "extcredits2Name": null,
          "extcredits2Unit": null,
          "extcredits3": null,
          "extcredits3Status": 1,
          "extcredits3Name": null,
          "extcredits3Unit": null,
          "extcredits4": null,
          "extcredits4Status": 1,
          "extcredits4Name": null,
          "extcredits4Unit": null,
          "extcredits5": null,
          "extcredits5Status": 1,
          "extcredits5Name": null,
          "extcredits5Unit": null
        },
        "archives": [],
        "operations": {
          "customizes": [],
          "buttonIcons": [],
          "diversifyImages": [],
          "tips": []
        },
        "extends": {
          "textBox": [],
          "infoBox": [],
          "interactionBox": []
        },
        "roles": [
          {
            "rid": 4,
            "isMain": true,
            "nicknameColor": null,
            "name": "普通会员",
            "nameDisplay": false,
            "icon": null,
            "iconDisplay": false,
            "expiryDateTime": null,
            "rankState": 1,
            "status": true
          }
        ],
        "interaction": {
          "userName": "用户",
          "userUidName": "用户号",
          "userUsernameName": "用户名",
          "userNicknameName": "昵称",
          "userRoleName": "角色",
          "userBioName": "简介",
          "followSetting": true,
          "followName": "关注",
          "likeSetting": false,
          "likeName": "喜欢",
          "dislikeSetting": false,
          "dislikeName": "不喜欢",
          "blockSetting": false,
          "blockName": "拉黑",
          "publishPostName": "发帖",
          "publishCommentName": "回复",
          "likeStatus": false,
          "dislikeStatus": false,
          "followStatus": false,
          "followMeStatus": false,
          "followNote": null,
          "followExpired": true,
          "followExpiryDateTime": null,
          "blockStatus": false,
          "blockMeStatus": false,
          "blockNote": null
        },
        "conversation": {
          "status": false,
          "code": 36600,
          "message": "对话功能未启用，无法使用"
        }
      },
      {
        "fsid": "admin",
        "uid": 11182,
        "username": "admin",
        "url": "/u/admin",
        "nickname": "Admin",
        "avatar": "http://localhost:8080/static/images/default-avatar.png",
        "decorate": null,
        "banner": null,
        "gender": 1,
        "birthday": null,
        "bio": null,
        "location": null,
        "conversationLimit": 1,
        "commentLimit": 1,
        "timezone": "+8",
        "verifiedStatus": false,
        "verifiedIcon": null,
        "verifiedDesc": null,
        "verifiedDateTime": null,
        "expired": false,
        "expiryDateTime": null,
        "lastPublishPost": null,
        "lastPublishComment": null,
        "lastEditUsername": null,
        "lastEditNickname": null,
        "registerDate": "2023-03-19 12:47:04",
        "hasPassword": false,
        "rankState": 1,
        "status": true,
        "waitDelete": false,
        "waitDeleteDateTime": null,
        "bioHtml": "",
        "nicknameColor": null,
        "rid": 1,
        "roleName": "管理员",
        "roleNameDisplay": false,
        "roleIcon": null,
        "roleIconDisplay": false,
        "roleExpiryDateTime": null,
        "roleRankState": 1,
        "rolePermissions": {
          "rid": 1,
          "content_view": true,
          "conversation": true,
          "content_link_handle": 3,
          "post_publish": true,
          "post_review": false,
          "post_email_verify": false,
          "post_phone_verify": false,
          "post_real_name_verify": false,
          "post_limit_status": false,
          "post_limit_type": 1,
          "post_limit_period_start": "2022-06-01 22:30:00",
          "post_limit_period_end": "2022-06-06 08:00:00",
          "post_limit_cycle_start": "23:00:00",
          "post_limit_cycle_end": "08:30:00",
          "post_limit_rule": 1,
          "post_second_interval": 60,
          "post_draft_count": 10,
          "comment_publish": true,
          "comment_review": false,
          "comment_email_verify": false,
          "comment_phone_verify": false,
          "comment_real_name_verify": false,
          "comment_limit_status": false,
          "comment_limit_type": 1,
          "comment_limit_period_start": "2022-06-01 22:30:00",
          "comment_limit_period_end": "2022-06-06 08:00:00",
          "comment_limit_cycle_start": "23:00:00",
          "comment_limit_cycle_end": "08:30:00",
          "comment_limit_rule": 1,
          "comment_second_interval": 60,
          "comment_draft_count": 10,
          "post_editor_image": true,
          "post_editor_image_upload_number": 9,
          "post_editor_video": true,
          "post_editor_video_upload_number": 1,
          "post_editor_audio": true,
          "post_editor_audio_upload_number": 2,
          "post_editor_document": true,
          "post_editor_document_upload_number": 10,
          "comment_editor_image": true,
          "comment_editor_image_upload_number": 9,
          "comment_editor_video": false,
          "comment_editor_video_upload_number": 1,
          "comment_editor_audio": false,
          "comment_editor_audio_upload_number": 2,
          "comment_editor_document": false,
          "comment_editor_document_upload_number": 10,
          "image_max_size": 5,
          "video_max_size": 50,
          "video_max_time": 60,
          "audio_max_size": 50,
          "audio_max_time": 60,
          "document_max_size": 10,
          "follow_user_max_count": 500,
          "block_user_max_count": 500,
          "download_file_count": 10
        },
        "roleStatus": true,
        "stats": {
          "likeUserCount": 0,
          "likeGroupCount": 0,
          "likeHashtagCount": 0,
          "likePostCount": 0,
          "likeCommentCount": 0,
          "dislikeUserCount": 0,
          "dislikeGroupCount": 0,
          "dislikeHashtagCount": 0,
          "dislikePostCount": 0,
          "dislikeCommentCount": 0,
          "followUserCount": 0,
          "followGroupCount": 0,
          "followHashtagCount": 0,
          "followPostCount": 0,
          "followCommentCount": 0,
          "blockUserCount": 0,
          "blockGroupCount": 0,
          "blockHashtagCount": 0,
          "blockPostCount": 0,
          "blockCommentCount": 0,
          "likeMeCount": 0,
          "dislikeMeCount": null,
          "followMeCount": 0,
          "blockMeCount": null,
          "postPublishCount": 0,
          "postDigestCount": 0,
          "postLikeCount": 0,
          "postDislikeCount": null,
          "postFollowCount": 0,
          "postBlockCount": null,
          "commentPublishCount": 0,
          "commentDigestCount": 0,
          "commentLikeCount": 0,
          "commentDislikeCount": null,
          "commentFollowCount": 0,
          "commentBlockCount": null,
          "extcredits1": null,
          "extcredits1Status": 1,
          "extcredits1Name": null,
          "extcredits1Unit": null,
          "extcredits2": null,
          "extcredits2Status": 1,
          "extcredits2Name": null,
          "extcredits2Unit": null,
          "extcredits3": null,
          "extcredits3Status": 1,
          "extcredits3Name": null,
          "extcredits3Unit": null,
          "extcredits4": null,
          "extcredits4Status": 1,
          "extcredits4Name": null,
          "extcredits4Unit": null,
          "extcredits5": null,
          "extcredits5Status": 1,
          "extcredits5Name": null,
          "extcredits5Unit": null
        },
        "archives": [],
        "operations": {
          "customizes": [],
          "buttonIcons": [],
          "diversifyImages": [],
          "tips": []
        },
        "extends": {
          "textBox": [],
          "infoBox": [],
          "interactionBox": []
        },
        "roles": [
          {
            "rid": 1,
            "isMain": true,
            "nicknameColor": null,
            "name": "管理员",
            "nameDisplay": false,
            "icon": null,
            "iconDisplay": false,
            "expiryDateTime": null,
            "rankState": 1,
            "status": true
          }
        ],
        "interaction": {
          "userName": "用户",
          "userUidName": "用户号",
          "userUsernameName": "用户名",
          "userNicknameName": "昵称",
          "userRoleName": "角色",
          "userBioName": "简介",
          "followSetting": true,
          "followName": "关注",
          "likeSetting": false,
          "likeName": "喜欢",
          "dislikeSetting": false,
          "dislikeName": "不喜欢",
          "blockSetting": false,
          "blockName": "拉黑",
          "publishPostName": "发帖",
          "publishCommentName": "回复",
          "likeStatus": false,
          "dislikeStatus": false,
          "followStatus": false,
          "followMeStatus": false,
          "followNote": null,
          "followExpired": true,
          "followExpiryDateTime": null,
          "blockStatus": false,
          "blockMeStatus": false,
          "blockNote": null
        },
        "conversation": {
          "status": false,
          "code": 36600,
          "message": "对话功能未启用，无法使用"
        }
      }
    ]
  }
}