GET/users/{userId}

Gets a member's email address.

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

Authorization

oauth2

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

Scope

user.email.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


readOnly : true 
email string 

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


maxLength : 90
readOnly : true 

Response Example

example

1{2  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "email": "localpart@example.com"4}

HTTP 404

Not Found