Query Home Members

Last Updated on : 2023-12-07 03:33:51download

Query the list of home members.

API address

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

Request parameter

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

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

{
    "result": [
        {
            "admin": true,
            "member_account": "18******176",
            "country_code": "86",
            "uid": "ay1528964101460q****",
            "name": "Hera"
        }
    ],
    "t": 1540799929837,
    "success": true
}

Error code

For more information, see error code.