Get Group Member List

Important Note

This feature is available in the Business plan. If you haven't upgraded yet, please upgrade before using this feature.

API Overview

• Function: Get Group Member List
• Request Method: GET
• Request URL: /api/contacts/teams/{team_id}/groups/{group_id}/users?appid={appid}&access_token={access_token}&page={1}&per_page={10}

Request Parameters

Parameter Name	Type	Required	Location	Description	Example
team_id	integer	Yes	uri	Team ID	30
group_id	integer	Yes	uri	Group ID	30
page	integer	No	queryString	Current Page Number	1
per_page	integer	No	queryString	Items Per Page	10
roles	array	No	queryString	Contact Management Roles (Different from Team Roles)	[1,2,3]

Response Parameters

Parameter Name	Type	Description
total	integer	Total Count
list	array[object]	Member List
list[_].user_id	integer(uint64)	Member Editor ID
list[_].respondent_id	integer(uint64)	Member Respondent ID
list[_].name	string	Member Name
list[_].avatar	string	Member Avatar
list[_].role	integer	Contact Management Role (0: Contact Admin; 1: Group Admin; 2: Regular Member)
list[_].group_full_name	string	Full Path of Group (e.g., Team/Level1/Level2/Level3)
list[_].group_id	int	Group ID

Response Examples

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {
        "total":1,
        "list": [
            {
                "user_id": 60000208205,
                "respondent_id": 60000208206,
                "name": "Zhang San",
                "avatar": "https://wesurvey.com/xxx/xxx.png",
                "role": 0,
                "group_full_name":"Team/Level1/Level2/Level3",
                "group_id":67
            }
        ]
    },
    "request_id": "d84e884b-3bc5-419d-9cc0-d6d6d14e68b6"
}

• Failed Request

{
    "code": "PermissionDenied",
    "error": {
        "type": "claim_error"
    },
    "data": {},
    "request_id": "5ffeb778-6046-42b2-b6f7-0c79ebc82288"
}

Error Codes

error.type Code	Description
invalid_argument	Invalid Parameter
claim_error	No Permission