Query User Information

Last Updated on : 2023-06-21 07:13:04download

Query basic user information by user ID. The returned information includes the name, mobile phone number, and email address.

API address

GET: /v1.0/iot-03/users/{uid}

Request parameter

Parameter name Type IN Required Description
uid String uri true The user ID.

Return parameter

Parameter name Type Description
result UserBaseRes The returned result.

Description of result

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 ender.
Valid values:
1: male.
2: female.
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/bay1622425045524****

Return example

{ "result": { "gender": "2", "end_time": 1622425046559, "mobile": "1915960****", "external_id": "cCigMzECiK****", "user_no": "c7x4iWVXhruGTyR****", "start_time": 1622425046558, "name": "BtSHOtui9d", "user_account": "Gxv3oKGksP****", "id": "bay1622425045524****", "email": "RqYyat****@tuya.com", "status": 0 }, "t": 1623377137775, "success": true }

Error code

For more information, see error code.