Query Family Member List

API Address:/v2/family/enduserapi/getFamilyMemberList

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:Query family member list

Request Parameters:

Parameter Name	Parameter Description	Request Type	Required	Data Type	Schema
fid	Family ID	query	true	string
page	Current page, default is page 1	query	false	integer(int32)
pageSize	Page size, default is 10 items	query	false	integer(int32)

Response Status:

Status Code	Description	Schema
200	Successfully queried family member list	Registration code response data«PageInfo«User Info»»
5628	User information not found
5635	Home mode not enabled
5636	Please enter family ID
5658	Member permission invalid

Response Parameters:

Parameter Name	Parameter Description	Type	Schema
code	Response status code	integer(int32)	integer(int32)
data	Response data	PageInfo«User Info»	PageInfo«User Info»
endRow		integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	User Info
acceptTime	Invitation acceptance time	string
address	Address	string
alipayUserId	Alipay user ID	string
appleUserId	Apple user ID	string
city	City	string
email	Email	string
facebookUserId	Facebook user ID	string
headimg	Profile picture	string
invalidTime	Invitation time	string
lang	Language	string
lastLoginTime	Last login time	string
lastLoginTimeTs		integer
memberName	User nickname	string
memberRole	Family member role: 1-Family creator, only has this role in families created by themselves 2-Family administrator 3-Regular family member	integer
nationality	Country	string
nikeName	Nickname	string
phone	Phone number	string
province	Province	string
qqUserId	QQ user ID	string
registerTime	Registration time	string
registerTimeTs		integer
remark	Remarks	string
sex	Gender	string
signature	Personal signature	string
status	Account status: 0 Disabled 1 Normal	integer
timezone	Timezone	string
twitterUserId	Twitter user ID	string
uid	User ID	string
userDomain	User domain	string
wechatMiniprogramUserId	WeChat Mini Program user ID	string
wechatOffiaccountUserId	WeChat Official Account user ID	string
wechatUnionId	WeChat Universal user ID	string
navigateFirstPage		integer(int32)
navigateLastPage		integer(int32)
navigatePages		integer(int32)
navigatepageNums		array	integer
nextPage		integer(int32)
pageNum		integer(int32)
pageSize		integer(int32)
pages		integer(int32)
prePage		integer(int32)
size		integer(int32)
startRow		integer(int64)
total		integer(int64)
extMsg	Extended message	string
msg	Response message	string

Response Example:

{
	"code": 0,
	"data": {
		"endRow": 0,
		"hasNextPage": true,
		"hasPreviousPage": true,
		"isFirstPage": true,
		"isLastPage": true,
		"list": [
			{
				"acceptTime": "",
				"address": "",
				"alipayUserId": "",
				"appleUserId": "",
				"city": "",
				"email": "",
				"facebookUserId": "",
				"headimg": "",
				"invalidTime": "",
				"lang": "",
				"lastLoginTime": "",
				"lastLoginTimeTs": 0,
				"memberName": "",
				"memberRole": 0,
				"nationality": "",
				"nikeName": "",
				"phone": "",
				"province": "",
				"qqUserId": "",
				"registerTime": "",
				"registerTimeTs": 0,
				"remark": "",
				"sex": "",
				"signature": "",
				"status": 0,
				"timezone": "",
				"twitterUserId": "",
				"uid": "",
				"userDomain": "",
				"wechatMiniprogramUserId": "",
				"wechatOffiaccountUserId": "",
				"wechatUnionId": ""
			}
		],
		"navigateFirstPage": 0,
		"navigateLastPage": 0,
		"navigatePages": 0,
		"navigatepageNums": [],
		"nextPage": 0,
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"prePage": 0,
		"size": 0,
		"startRow": 0,
		"total": 0
	},
	"extMsg": "",
	"msg": ""
}