English
English
简体中文
Contact Us
Register
Log In

Search Family

Last Updated on : 2022-04-29 05:34:29download

Query basic family information based on family ID.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
home_idLonguritrueFamily ID

Return parameter

Parameter nameTypeDescription
resultHomeRes

Description of result

Parameter nameTypeDescription
home_idLongFamily ID
nameStringFamily Name
lonDoubleLongitude
latDoubleLatitude
geo_nameStringFamily detailed address
roleStringRoles

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.