GET/groups/{groupId}/members

Gets a list of group members. This API operation cannot get external group members.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

directory
directory.read
group
group.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups/{groupId}/members

Path Parameters

ParameterTypeDescription
groupId string 

Group ID or external key.
External key in "externalKey:{externalKey}" format


required 

Query Parameters

ParameterTypeDescription
domainId integer 

Domain ID


example : 10000001
format : int32 
count integer 

Number of items to get


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

Cursor


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Response

HTTP 200

OK

PropertyTypeDescription
members array (GroupMember) 

List of group members

 
responseMetaData object (responseMetaData) 

Response metadata

 

GroupMember

PropertyTypeDescription
externalKey string 

Member external key


readOnly : true 
id string 

Member, team, or group ID.
The following types are available for a member ID:
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required 
type string 

required
Allowed values : USER, ORGUNIT, GROUP 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "members": [3    {4      "externalKey": "USER_EXT_01",5      "id": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "type": "USER"7    },8    {9      "externalKey": "ORGUNIT_EXT_01",10      "id": "orgunitf-f27f-4af8-27e1-03817a911417",11      "type": "ORGUNIT"12    },13    {14      "externalKey": "GROUP_EXT_01",15      "id": "group769-e656-477d-69c7-04e2f73a4a77",16      "type": "GROUP"17    }18  ],19  "responseMetaData": {20    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="21  }22}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found