GET/users/{userId}

Gets a member's profile information.

  • This API operation requires an access token with the user.profile.read scope.
  • Using an access token with the user or user.read scope, it gets member information.

Caution

  • The properties you can get differ depending on Member > Member > Manage Items in the LINE WORKS Admin.

Authorization

oauth2

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

Scope

user.profile.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}

Path Parameters

ParameterTypeDescription
userId string 

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
userId string 

Member ID

 
userExternalKey string 

Customer's member external key. %, \, #, /, ? are not allowed.


maxLength : 100
nullable : true 
email string 

Account

  • It is the same as the member's email address (id@domain for Standard, id@group for Advanced).

maxLength : 90 
userName object (userName) 

Name information

 
i18nNames array (Useri18nName) 

List of multilingual names


minItems : 0 
organizations array (UserOrganization) 

List of domains (companies) to which the member belongs,
including both the primary and secondary positions.


minItems : 0 
telephone string 

Phone number


maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100}
nullable : true 
cellPhone string 

Mobile phone number


maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100}
nullable : true 
location string 

Office location


maxLength : 100
nullable : true 

userName

PropertyTypeDescription
lastName string 

Last name


maxLength : 80
nullable : true 
firstName string 

First name


maxLength : 80
nullable : true 
phoneticLastName string 

Last name in Furigana


maxLength : 100
nullable : true 
phoneticFirstName string 

First name in Furigana


maxLength : 100
nullable : true 

Useri18nName

PropertyTypeDescription
language string 

Language code


Allowed values : ko_KR, ja_JP, zh_CN, zh_TW, en_US 
firstName string 

First name in the language.
The last name is followed by the first name in the organization chart.


maxLength : 100
nullable : true 
lastName string 

Last name in the language
The last name is followed by the first name in the organization chart.


maxLength : 100
nullable : true 

UserOrganization

PropertyTypeDescription
domainId integer 

Domain ID


format : int32 
userExternalKey string 

Caution

  • It references the top-level 'userExternalKey' value instead of 'organizations[].userExternalKey'.

Customer's member external key

  • %, , #, /, ? are not allowed.

maxLength : 100
readOnly : true
nullable : true 
primary boolean 

Indicates whether it is the primary domain.

 
email string 

Email address


maxLength : 90 
levelId string 

Job level ID


nullable : true 
levelExternalKey string 

Customer's job level external key


maxLength : 100
nullable : true 
levelName string 

Job level name


nullable : true 
executive boolean 

Indicates whether the member is an executive or not.

 
organizationName string 

Company name

 
orgUnits array (object) 

List of teams


minItems : 0
maxItems : 30 

object

PropertyTypeDescription
orgUnitId string 

Team ID

 
orgUnitExternalKey string 

Customer's team external key


maxLength : 100
nullable : true 
orgUnitName string 

Team name

 
orgUnitEmail string 

Team email address

 
primary boolean 

Indicates whether it is the primary team.

 
positionId string 

Position ID


nullable : true 
positionExternalKey string 

Customer's position external key


maxLength : 100
nullable : true 
positionName string 

Position name


nullable : true 
isManager boolean 

Indicates whether the member is a team leader.


default : false 
visible boolean 

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


default : true 
useTeamFeature boolean 

Indicates whether to use the team features (default: true).
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.

default : true 

Response Example

example

1{2  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "userExternalKey": null,4  "email": "localpart@example.com",5  "telephone": "031-1234-5678",6  "cellPhone": "010-1234-5678",7  "location": "green building",8  "userName": {9    "lastName": "last",10    "firstName": "first",11    "phoneticLastName": null,12    "phoneticFirstName": null13  },14  "i18nName": [],15  "organizations": [16    {17      "domainId": 10000001,18      "primary": true,19      "userExternalKey": null,20      "email": "localpart@example.com",21      "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",22      "levelExternalKey": null,23      "levelName": "level",24      "executive": false,25      "organizationName": "org",26      "orgUnits": [27        {28          "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",29          "orgUnitExternalKey": null,30          "orgUnitEmail": "team01@example.com",31          "orgUnitName": "orgUnit1",32          "primary": true,33          "positionId": "position-7027-4a02-b838-6f52b5e38db7",34          "positionExternalKey": null,35          "positionName": "position",36          "isManager": true,37          "visible": true,38          "useTeamFeature": true39        }40      ]41    }42  ]43}

HTTP 404

Not Found