GET/orgunits

Gets a list of teams.

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

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 

Response

HTTP 200

OK

PropertyTypeDescription
orgUnits array (OrgUnit) 

List of teams

 
responseMetaData object (responseMetaData) 

Response metadata

 

OrgUnit

PropertyTypeDescription
domainId integer 

Domain ID


required
format : int32 
orgUnitId string 

Resource ID


readOnly : true 
orgUnitExternalKey string 

Customer's external key

Some special characters, %, \, #, /, ? are not allowed.


maxLength : 100
nullable : true 
orgUnitName string 

Team name. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . /.


required
maxLength : 100 
i18nNames array (OrgUniti18nName) 

List of multilingual names

 
email string 

Team email address (localpart@domain or localpart@group). It is required to update a team.

  • The entire email address can be up to 90 characters long.
  • The localpart must start with a lowercase English letter, a number, an exclamation mark (!), or a number sign (#).
  • The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
  • The localpart can be between 2 and 64 characters long and can only contain lowercase English letters, numbers, dot (.), hyphen (-), underscore (_), exclamation mark (!), and number sign (#).

maxLength : 90 
description string 

Team description


maxLength : 160
nullable : true 
visible boolean 

Indicates whether to make the team visible.


default : true 
parentOrgUnitId string 

Parent team ID

  • Resource ID
  • External key in "externalKey:{orgUnitExternalKey}" format

nullable : true 
parentExternalKey string 

Parent team external key


readOnly : true
nullable : true 
displayOrder integer 

Ordering between the teams that share the same parent team. It is required only when a team is added. It is ignored when a team is updated.


minimum : 1
format : int32 
displayLevel integer 

Team depth (starting from 1)


minimum : 1
format : int32
readOnly : true 
aliasEmails array (string) 

List of email aliases.

  • Available only for the Advanced plan.

minItems : 0
maxItems : 20 
canReceiveExternalMail boolean 

Indicates whether to receive external emails.


default : false 
useMessage boolean 

Indicates whether to use the Message Room features.

  • If it is set to "false", the chat history of all the members is deleted and the Message Room features (Note, Calendar, Folder, and Task) are disabled after 30 days.
  • Set this parameter to "true" again within 30 days to recover the previous data. Setting it to "true" after 30 days cannot recover the previous data; it only creates a new message room.

default : false 
useNote boolean 

Indicates whether to use the Message Room Note feature.

  • If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
  • This parameter is available only when useMessage is "true".

default : false 
useCalendar boolean 

Indicates whether to use the Message Room Calendar feature.

  • If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
  • This parameter is available only when useMessage is "true".

default : false 
useTask boolean 

Indicates whether to use the Message Room Task feature.

  • If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
  • This parameter is available only when useMessage is "true".

default : false 
useFolder boolean 

Indicates whether to use the Message Room Folder feature.

  • If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
  • This parameter is available only when useMessage is "true".

default : false 
useServiceNotification boolean 

Indicates whether to use service notifications.


default : false 
membersAllowedToUseOrgUnitEmailAsRecipient array (OrgUnitAllowedMember) 

List of members who can send an email to the team email address.


minItems : 0 
membersAllowedToUseOrgUnitEmailAsSender array (OrgUnitAllowedMember) 

List of members who can use the team email address as their From address. Only team members are allowed.


minItems : 0 

OrgUniti18nName

PropertyTypeDescription
language string 

Language


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
name string 

Multilingual name The allowed special characters are ! @ & ( ) - _ + [ ] { } , . /.


required
maxLength : 100 

OrgUnitAllowedMember

PropertyTypeDescription
userId string 

Member ID


required 
userExternalKey string 

Customer's external key


readOnly : true
nullable : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "orgUnits": [3    {4      "domainId": 10000001,5      "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",6      "orgUnitExternalKey": "externalKeyValue",7      "orgUnitName": "name01",8      "i18nNames": [9        {10          "language": "en_US",11          "name": "Team01"12        }13      ],14      "email": "team01@example.com",15      "description": "desc",16      "visible": true,17      "parentOrgUnitId": "parernt9-ffda-4395-24a8-03fb9e22e051",18      "parentExternalKey": "parentExtKeyValue",19      "displayOrder": 1,20      "displayLevel": 1,21      "aliasEmails": [22        "alias@example.com"23      ],24      "canReceiveExternalMail": true,25      "useMessage": true,26      "useNote": true,27      "useCalendar": true,28      "useTask": true,29      "useFolder": true,30      "useServiceNotification": true,31      "membersAllowedToUseOrgUnitEmailAsRecipient": [32        {33          "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569",34          "userExternalKey": "userExtKeuy"35        }36      ],37      "membersAllowedToUseOrgUnitEmailAsSender": [38        {39          "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569",40          "userExternalKey": "userExtKeuy"41        }42      ]43    }44  ],45  "responseMetaData": {46    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="47  }48}