# 获取用户列表

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getuserlist

通过该接口可分页获取店铺的小店会员用户列表，返回每个用户的 openid、unionid、等级和经验值信息。 

[会员营销开发指南](/doc/store/shop/guide/marketing/vip)

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/vip/user/list/get?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "page_num",
    "类型": "number",
    "必填": "是",
    "说明": "当前页，从 1 开始"
  },
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "是",
    "说明": "每页数量，最大 200"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "list",
    "类型": "objarray",
    "说明": "用户信息列表"
  },
  {
    "参数名": "total_num",
    "类型": "number",
    "说明": "会员用户总数"
  }
]
```

">

### Res.list(Array) `Object Payload`

用户信息列表

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "用户 openid"
  },
  {
    "参数名": "unionid",
    "类型": "string",
    "说明": "用户 unionid"
  },
  {
    "参数名": "user_grade_info",
    "类型": "object",
    "说明": "用户等级信息"
  }
]
```

__user_grade_info">

### Res.list(Array).user_grade_info `Object Payload`

用户等级信息

```json
[
  {
    "参数名": "grade",
    "类型": "number",
    "说明": "会员等级"
  },
  {
    "参数名": "experience_value",
    "类型": "number",
    "说明": "当前等级经验值"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "page_num": 1,
    "page_size": 10
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "list": [
        {
            "openid": "oABCD000111222333444555666",
            "unionid": "uABCD000111222333444555666",
            "user_grade_info": {
                "grade": 3,
                "experience_value": 1000
            }
        }
    ],
    "total_num": 1230
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "10100001",
    "错误描述": "系统错误",
    "解决方案": "请稍后重试"
  },
  {
    "错误码": "10100002",
    "错误描述": "参数错误",
    "解决方案": "检查 page_num 和 page_size 是否合法"
  },
  {
    "错误码": "10100003",
    "错误描述": "信息不存在",
    "解决方案": "确认店铺是否已开通会员功能"
  }
]
```

## 7. 适用范围

本接口支持「微信小店（需开通）」账号类型调用。其他账号类型如无特殊说明，均不可调用。

![](https://res8.wxqcloud.qq.com.cn/wxdoc/56617deb-b17d-4cf1-bccd-71d2c41ccc76.svg)接口变更日志（1条）
2025 年 11 月 24 日补充小店会员申请关联文档