Cloud Services API ReferenceIndustrial ScenariosIndustry Basic ServiceIndustry User ManagementQuery User Information on Pages

Query User Information on Pages

Last Updated on : 2023-06-20 15:20:09download

Query the list of users based on the user ID list and merchant code.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
query_user_request	QueryUserRequest	query	false	The query criteria.
last_row_key	String	query	false	The row key of the last entry on each page.
page_size	Integer	query	false	The number of items to be returned per page.

Description of query_user_request

Parameter name	Type	Required	Description
user_nick_name	String	false	The nickname of a specified user.
user_ids	String	false	The list of user IDs.
user_names	String	false	The list of account names.

Return parameter

Parameter name	Type	Description
result	QueryMerUsersResponse	The returned result.

Description of result

Parameter name	Type	Description
list	List	The list of users.
last_row_key	String	The row key of the last entry on each page.
page_size	Integer	The number of items to be returned per page.
has_next	Boolean	Specifies whether to return the next page.

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.

Request example

GET: /v1.1/iot-02/users?merchantCode=****12323&last_row_key=xxid&page_size=20

Return example

{
    "result": {
        "last_row_key": "1480****472",
        "list": [
            {
                "create_time": 1641796814496,
                "user_name": "userFgMU",
                "user_nick_name": "abc",
                "country_code": "86",
                "user_id": "bay1****O7eE",
                "tenant_code": "aym0****1426"
            }
        ],
        "has_next": false,
        "page_size": 10
    },
    "t": 1641796817818,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify User Information

Next DocQuery User by Username