Get Team 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 Team Member List
• Request Method: GET
• Request URL: /api/contacts/teams/{team_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
page	integer	No	queryString	Current Page Number	1
per_page	integer	No	queryString	Items Per Page	10
roles	array	No	queryString	Role Types	[1,2,3]

Response Parameters

Parameter Name	Type	Description
total	integer	Total Users Count
list	array[object]	User List
list[_].avatar	string	User Avatar
list[_].group_full_name	string	Group Path
list[_].is_org_available	integer	Organization Availability Status
list[_].is_org_creator	integer	Organization Creator Status
list[_].name	string	User Name
list[_].respon_id	integer	Respondent ID
list[_].role	integer	User Role Permission
list[_].user_id	integer	User ID
list[_].group_id	integer	Group ID

Response Examples

• Successful Request

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {
        "total": 1,
        "list": [
            {
                "avatar": "https://wj.gtimg.com/default/default_headimg.png",
                "group_full_name": "Test Group/Test Subgroup",
                "is_org_available": true,
                "is_org_creator": false,
                "name": "jeterli3",
                "respon_id": 0,
                "role": 3,
                "user_id": 60000000285,
                "group_id": 6031
            }
        ]
    },
    "request_id": "d7c407f1-95c3-4fce-b7fc-90ba22602b99"
}

• Failed Request

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

Error Codes

error.type Code	Description
claim_error	No Permission
invalid_argument	Parameter Validation Failed