被邀请用户列表

  • 接口说明： 被邀请用户列表
  • 接口地址： /invite/users
  • 请求方式： GET

请求参数

参数名称类型是否必须描述
filter[scale]int否查询邀请的用户里 0没分成的 1有分成的
page[limit]int否分页数据条数
page[number]int否页码
sortstring否排序：固定值 正序 created_at 倒序 -created_at
filter[username]string否筛选被邀请的用户

请求示例

  1. {{host}}/api/invite/users?filter[scale]=1&page[limit]=20&page[number]=1

返回说明

  • 成功，http 状态码： 200
  • 失败，http 状态码： 404

返回结果

参数名称类型描述
pidint上级id(邀请人ID)
user_idint用户ID(被邀请人ID)
invites_codestring关联邀请码
be_scaleint受邀时的分成比例
levelint当前用户所处深度
created_atdatetime注册时间
updated_atdatetime最后活动时间

返回示例

  1. {
  2.     "links": {
  3.         "first": "http://www.xxx.com/api/invite/users?filter%5Bscale%5D=1&page%5Blimit%5D=20",
  4.         "last": "http://www.xxx.com/api/invite/users?filter%5Bscale%5D=1&page%5Blimit%5D=20"
  5.     },
  6.     "data": [
  7.         {
  8.             "type": "invite_user",
  9.             "id": "1",
  10.             "attributes": {
  11.                 "pid": 4,
  12.                 "user_id": 5,
  13.                 "invites_code": "pK0iMUDagTB5xxxxxxxxxSo1aFD7",
  14.                 "be_scale": 2,
  15.                 "level": 1,
  16.                 "updated_at": "2019-12-25T17:27:00+08:00",
  17.                 "created_at": "2019-12-25T17:27:00+08:00"
  18.             },
  19.             "relationships": {
  20.                 "user": {
  21.                     "data": {
  22.                         "type": "users",
  23.                         "id": "5"
  24.                     }
  25.                 }
  26.             }
  27.         }
  28.     ],
  29.     "included": [
  30.         {
  31.             "type": "users",
  32.             "id": "5",
  33.             "attributes": {
  34.                 "id": 5,
  35.                 "username": "三脚猫",
  36.                 "avatarUrl": "",
  37.                 "isReal": false,
  38.                 "threadCount": 5,
  39.                 "followCount": 0,
  40.                 "fansCount": 0,
  41.                 "likedCount": 0,
  42.                 "signature": "",
  43.                 "usernameBout": 0,
  44.                 "status": 0,
  45.                 "loginAt": "2020-08-05T22:46:20+08:00",
  46.                 "joinedAt": "2020-04-16T19:29:27+08:00",
  47.                 "expiredAt": null,
  48.                 "createdAt": "2020-04-16T19:29:27+08:00",
  49.                 "updatedAt": "2020-08-05T22:47:09+08:00",
  50.                 "canEdit": true,
  51.                 "canDelete": true,
  52.                 "showGroups": true,
  53.                 "registerReason": "",
  54.                 "banReason": "",
  55.                 "denyStatus": false,
  56.                 "originalMobile": "",
  57.                 "registerIp": "127.xxx.xxx.xxx",
  58.                 "registerPort": 0,
  59.                 "lastLoginIp": "127.0.0.1",
  60.                 "lastLoginPort": 62880,
  61.                 "identity": "",
  62.                 "realname": "",
  63.                 "mobile": "",
  64.                 "hasPassword": true,
  65.                 "canEditUsername": true
  66.             }
  67.         }
  68.     ],
  69.     "meta": {
  70.         "total": 1,
  71.         "pageCount": 1
  72.     }
  73. }