Query Home Members

Last Updated on : 2024-09-10 09:51:53

Query the list of home members based on the home ID.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
home_id	Long	uri	true	The home ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
country_code	String	The country code of a specified home member.
member_account	String	The account of a specified home member.
uid	String	The user ID of a specified home member.
admin	Boolean	Determine whether a home member is an administrator. Valid values: `true`: yes. `false`: no.
name	String	The name of a specified home member.
avatar	String	The avatar of a specified home member.
owner	Boolean	Determine whether a home member is the home owner. Valid values: `true`: yes. `false`: no.

Request example

GET: /v1.0/homes/242****/members

Return example

{
    "tid": "b0fd5f777d361*****2c7664ef4d3e193",
    "result": [
        {
            "owner": true,
            "admin": true,
            "avatar": "https://images.tuyacn.com/app/default_avatar/avatar4.png",
            "member_account": "86-*********05",
            "country_code": "86",
            "uid": "ay15913*****0677KZlj2",
            "name": "vt.y"
        }
    ],
    "t": 1699338434674,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Devices in Home

Next DocAdd Home Member