Query User Information on Pages

Last Updated on : 2023-06-20 14:22:30download

Query a list of users on pages based on pageSize.

API address

GET: /v1.1/iot-02/users/page

Request parameter

Parameter nameTypeINRequiredDescription
page_user_requestPageUserRequestqueryfalseThe query criteria.

Description of page_user_request

Parameter nameTypeINRequiredDescription
user_nick_nameString falseThe nickname of a specified user.
user_idString falseThe user ID.
user_nameString falseThe username.
page_noInteger trueThe current page number.
page_sizeInteger trueThe number of entries returned on each page.
reg_originInteger falseThe source of registration.

Return parameter

Parameter nameTypeDescription
resultQueryUsersPageResponseThe returned result.

Description of result

Parameter nameTypeDescription
page_countIntegerThe total number of pages.
page_sizeIntegerThe number of entries returned on each page.
listListThe list of returned users.
current_pageIntegerThe current page number.
records_countIntegerThe total number of entries to be returned.

Description of list

Parameter nameTypeDescription
user_nameStringThe username.
country_codeStringThe country code.
user_idStringTuya user ID.
user_nick_nameStringThe nickname of a specified user.
account_typeIntegerThe account type.
create_timeLongThe time when it is created.
tenant_codeStringThe code of a specified tenant.
emailStringThe email address.
mobileStringThe mobile phone number.
reg_originIntegerThe source of registration.

Request example

GET: /v1.1/iot-02/users/page?pageNo=1&page_size=20

Return example

    "tid": "3bd****ca36",
    "result": {
        "records_count": 1,
        "list": [
                "create_time": 1652153052245,
                "user_name": "134***11@qq.com",
                "mobile": "134****5102",
                "user_nick_name": "James",
                "reg_origin": 1,
                "country_code": "86",
                "user_id": "bay16****09qh",
                "email": "69516****@qq.com"
        "current_page": 1,
        "page_count": 1,
        "page_size": 5
    "t": 1656397585210,
    "success": true

Error code

For more information, see error code.