Query User Information on Pages

Last Updated on : 2023-06-20 15:22:45download

Query a list of users on pages based on pageSize.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
page_user_request	PageUserRequest	query	false	The query criteria.

Description of page_user_request

Parameter name	Type	Required	Description
user_nick_name	String	false	The nickname of a specified user.
user_id	String	false	The user ID.
user_name	String	false	The username.
page_no	Integer	true	The current page number.
page_size	Integer	true	The number of entries returned on each page.
reg_origin	Integer	false	The source of registration.

Return parameter

Parameter name	Type	Description
result	QueryUsersPageResponse	The returned result.

Description of result

Parameter name	Type	Description
page_count	Integer	The total number of pages.
page_size	Integer	The number of entries returned on each page.
list	List	The list of returned users.
current_page	Integer	The current page number.
records_count	Integer	The total number of entries to be returned.

Description of list

Parameter name	Type	Description
user_name	String	The username.
country_code	String	The country code.
user_id	String	Tuya user ID.
user_nick_name	String	The nickname of a specified user.
account_type	Integer	The account type.
create_time	Long	The time when it is created.
tenant_code	String	The code of a specified tenant.
email	String	The email address.
mobile	String	The mobile phone number.
reg_origin	Integer	The 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.

Prev DocQuery User by Username

Next DocIndustry Device Registration