Menu

Query member

Please update to the latest patch version to use it.

Basics

GET /api/v2/user/list

Description: Check a certain member or all the members' information from a certain user group 

Request Parameters

Optional Body parameters can be omitted.

Name Type Necessary Default Example  Description
user_id list No - ["user_xxx","user_xxx"] user id of the queried user,up to 50 at once
user_group_id text No - "xxx" user group id
email list No - ["123@123.com","234@123.com"] Account email of the queried user, up to 50 at once.
page text No 1 1 Page number, default value 1. 
limit text No 1 50 Default value 1: How many data are returned per page? Parameter range: 1-200. 

Return Data

// operation successed
{
    "data": {
        "list": [
            {
                "user_id": "xxx",  //user id, unique
                "user_group_id": "0",  //user group id,"-1"=owner;"0"=this member is deleted
                "name": "123@123.com", //name of the member
                "email": "123@123.com", //account email of the member
                "phone": "", //phone number linked to member account
                "identity": "4", //identity of the member
                "manager": "xxx", //manager of the member, user id
                "member": [], //members under this member, user id
                "authorized_group": ["all" ], //authorized groups,all=all groups
                "profile_limit": "100000",  //number of profiles that the member can create
                "remark": "" //remark
            },
            {
                "user_id": "xxx",  //user id, unique
                "user_group_id": "xxx",  //user group id,"-1"=owner;"0"=this member is deleted
                "name": "234@123.com", //name of the member
                "email": "234@123.com", //account email of the member
                "phone": "13512345678", //phone number linked to member account
                "identity": "3", //identity of the member
                "manager": "", //manager of the member, user id
                "member": ["xxx","xxx"], //members under this member, user id
                "authorized_group": [], //authorized groups,all=all groups
                "profile_limit": "-1",  //number of profiles that the member can create,-1 means no restriction
                "remark": "" //remark
            },
            {
                "user_id": "xxx",  //user id, unique
                "user_group_id": "-1",  //user group id,"-1"=owner;"0"=this member is deleted
                "name": "456@123.com", //name of the member
                "email": "456@123.com", //account email of the member
                "phone": "", //phone number linked to member account
                "identity": "1", //identity of the member,1: owner
                "manager": "", //manager of the member, user id
                "member": [], //members under this member, user id
                "authorized_group": ["all"], //authorized groups,all=all groups
                "profile_limit": "-1",  //number of profiles that the member can create,-1 means no restriction
                "remark": "" //remark
            }
        ],
        "page": 1,
        "page_size": 50
    },
    "code": 0,
    "msg": "Success"
}

// operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
Previous
Delete member
Next
Query user group
Last modified: 2025-06-05Powered by