Query User Information

Last Updated on : 2023-06-21 07:13:08

Query the data of a single user or multiple users according to username or user list page.

API address

GET: /v1.0/iot-03/users

Request parameter

Parameter name	Type	IN	Required	Description
user_condition_req	QueryUserConditionReq		false	The request of querying the user information.

Description of user_condition_req

Parameter name	Type	Required	Description
name	String	false	The username.
mobile	String	false	The mobile phone number.
email	String	false	The email address.
user_no	String	false	The work number.
org_id	String	false	The ID of a specified organization.
last_row_key	String	false	The device ID in the last entry on each page.
page_size	Integer	false	The number of items returned on each page.

Return parameter

Parameter name	Type	Description
result	CursorPage

Description of result

Parameter name	Type	Description
has_more	Boolean	Specifies whether to return the next page.
list	List
last_row_key	String	The device ID in the last entry on each page.

Description of list

Parameter name	Type	Description
id	String	The user ID.
external_id	String	The external ID.
user_no	String	The student number or work number.
user_account	String	The username.
name	String	The name.
mobile	String	The mobile phone number.
email	String	The email address.
gender	String	The gender.
status	Integer	The status. Valid values: `0`: Disabled. `1`: Enabled.
start_time	Long	The start time.
end_time	Long	The end time.

Request example

GET: /v1.0/iot-03/users?page_size=20&name=tset****

Return example

{
    "result": {
        "last_row_key": "140261201717238****",
        "list": [
            {
                "gender": "1",
                "end_time": 1621183690538,
                "mobile": "1667677****",
                "external_id": "322****",
                "user_no": "2013****",
                "start_time": 1621183630538,
                "name": "jinyunt****",
                "user_account": "1112323****",
                "id": "bsh1621492009764I****",
                "email": "123****@tuya.com",
                "status": 1
            }
        ],
        "has_more": false
    },
    "t": 1623772488275,
    "success": true
}

Error code

For more information, see error code.

Prev DocUser-bound organization

Next DocCampus and Office Organization and Management