English
English
简体中文
Contact Us
Register
Log In

Query Home Members

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

Query the list of home members.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
home_idLonguritrueThe ID of a home.

Return parameter

Parameter nameTypeDescription
resultListThe returned result.

Description of result

Parameter nameTypeDescription
country_codeStringThe country code of a specified home member.
member_accountStringThe account of a specified home member.
uidStringThe user ID of a specified home member.
adminBooleanDetermine whether a home member is an administrator. Valid values:
  • true: yes.
  • false: no.
nameStringThe name of a specified home member.
avatarStringThe avatar of a specified home member.
ownerBooleanDetermine 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.