GET/orgunits/{orgUnitId}/members

Gets a list of team members.

Authorization

oauth2

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

Scope

directory
directory.read
orgunit
orgunit.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/orgunits/{orgUnitId}/members

Path Parameters

ParameterTypeDescription
orgUnitId string 

Team ID
- Resource ID
- External Key in "externalKey:{externalKey}" format


required
example : orgunitf-f27f-4af8-27e1-03817a911417 

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 (OrgUnitMember) 

List of team members

 
responseMetaData object (responseMetaData) 

Response metadata

 

OrgUnitMember

PropertyTypeDescription
userId string 

Member ID


readOnly : true 
userExternalKey string 

Member external key


maxLength : 100
readOnly : true
nullable : true 
isManager boolean 

Indicates whether the member is a team leader.


readOnly : true 
visible boolean 

Indicates whether to make the member visible. It indicates whether to make the member visible in the organization chart.


readOnly : true 
useTeamFeature boolean 

Indicates whether to use the team features. Use this parameter to restrict a member's use of the team features for security purposes, such as: receiving messages, sharing files and receiving team emails in the team's message room. If it is "true", the member can join the team's message room (Message/Note/Calendar/Folder) and use the following team features:

  • Receive email messages sent to the team.
  • Receive calendar events shared to the team.
  • View the team calendar.
  • View files in the drive shared to the team.
  • View boards with the permissions given to the team.
  • Respond to surveys of the team.
  • Become a member of the groups which the team belongs to. If it is "false", all the team features described above are disabled. Set this parameter to "false" if you want the member not to use the team features.

readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "members": [3    {4      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",5      "userExternalKey": "USER_EXT_01",6      "isManager": true,7      "visible": true,8      "useTeamFeature": true9    }10  ],11  "responseMetaData": {12    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="13  }14}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found