Query user family list

Last Updated on : 2023-06-19 07:07:22

Query the list of households where the user is located.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
uid	String	uri	true	User ID

Return parameter

Parameter name	Type	Description
result	List

Description of result

Parameter name	Type	Description
home_id	Long	Family ID
name	String	Family Name
lon	Double	Longitude
lat	Double	Latitude
geo_name	String	Family detailed address
role	String	Roles

Request example

GET: /v1.0/users/ay152896hugoxxxx0qLVPu/homes

{}

Return example

{
    "result": [
        {
            "lon": 120.1,
            "name": "Nest",
            "home_id": 2421212,
            "lat": 30.27,
            "geo_name": "Gudang Street in Lake District"
        }
    ],
    "t": 1541508940996,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Room Device

Next DocAdd Device to Room