Search Family

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

Query basic family information based on family ID.

API address

GET: /v1.0/homes/{home_id}

Request parameter

Parameter name	Type	IN	Required	Description
home_id	Long	uri	true	Family ID

Return parameter

Parameter name	Type	Description
result	HomeRes

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/homes/3182004

{}

Return example

{
    "result": {
        "lon": 120.5,
        "name": "Ming Ming’s Family",
        "home_id": 318312,
        "lat": 30.16,
        "geo_name": "Hangzhou City, Tuya Smart"
    },
    "t": 1540955256215,
    "success": true
}

Error code

For more information, see error code.

Prev DocAdd Home

Next DocModify Home