Get User Information

Last Updated on : 2024-09-10 01:49:18

Get the details of the specified user based on the user ID.

API address

GET: /v1.0/users/{uid}/infos

Request parameter

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

Return parameter

Parameter name	Type	Description
result	UserRes	The returned result.

Description of result

Parameter name	Type	Description
uid	String	The user ID (UID).
username	String	The username.
country_code	String	The country code.
mobile	String	The phone number (only available to users who have registered with a phone number).
email	String	The email address (only available to users who have registered with an email address).
nick_name	String	The nickname of the specified user.
avatar	String	The avatar of the specified user.
create_time	Long	The time when it was created.
update_time	Long	The time when it was updated.
user_properties	List	The property of the specified user.
time_zone_id	String	The ID of the specified time zone.
temp_unit	Integer	The unit of temperature.

Description of user_properties

Parameter name	Type	Description
code	String	The property code of the specified user.
value	String	The property value of the specified user.

Request example

GET: /v1.0/users/ay1234***/infos

Return example

{
    "create_time": 1591350950,
    "user_properties": [
        {
            "code": "dataAuthorization",
            "value": "1"
        },
        {
            "code": "marketingPush",
            "value": "1"
        }
    ],
    "mobile": "86-1555****005",
    "avatar": "https://images.tuyacn.com/app/default_avatar/avat***.png",
    "country_code": "86",
    "uid": "ay1591350950677KZ***",
    "update_time": 1698716279,
    "nick_name": "vt.y",
    "time_zone_id": "Asia/Shanghai",
    "email": "",
    "temp_unit": 1,
    "username": "86-1555****005"
}

Error code

For more information, see error code.

Prev DocSync User Account

Next DocGet User List