Get Current Login User Profile Properties Through REST API

This article shows how to get the current login User Profile Properties using the REST API.

Introduction

User profile properties provide information about SharePoint users, such as display name, email, account name and other business and personal information including custom properties.



Imagine

Imagine I want to retrieve a custom field from the user profile property with REST. The property is searchable in a search box. The name of the custom properties are "Employee ID" and "Division”.

But when I try to use http://siteurl/_api/SP.UserProfiles.PeopleManager/GetMyProperties, it does not retrieve the custom properties, on the contrary I can see only the built-in properties like:
  • AccountName
  • DisplayName
I get a node that says UserProfileProperties. Where is a key? So how do I use this?

Let's proceed

I've created a UserProfile with some custom properties.

When I use http://siteurl/_api/SP.UserProfiles.PeopleManager/GetMyProperties, I get a result set with all UserProfile properties, including my custom properties. Right now I am using a workaround that iterates through the (big) result set with all properties to get my custom property.

Step 1: Navigate to your SharePoint 2013 site.

Step 2: From this page select the Site Actions | Edit Page.

Edit the page, go to the "Insert" tab in the Ribbon and click the "Web Part" option. In the "Web Parts"dialogue, go to the "Media and Content" category, select the "Script Editor" Web Part and click the "Add button".

Step 3: Once the Web Part is inserted into the page, you will see an "EDIT SNIPPET" link; click it. You can insert the HTML and/or JavaScript as in the following:
  1. <script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery:1.10.1.min.js"></script>  
  2.   
  3.     <script type='text/javascript'>  
  4.   
  5.           
  6.         var workEmail = "";  
  7.         var EmployeeID = "";  
  8.         var Division = "";  
  9.         var userDisplayName = "";  
  10.         var AccountName = "";  
  11.   
  12.         $.ajax({  
  13.   
  14.             url: _spPageContextInfo.webAbsoluteUrl + "/_api/SP.UserProfiles.PeopleManager/GetMyProperties",  
  15.             headers: { Accept: "application/json;odata=verbose" },  
  16.             success: function (data) {  
  17.                 try {  
  18.                     //Get properties from user profile Json response  
  19.                     userDisplayName = data.d.DisplayName;  
  20.                     AccountName = data.d.AccountName;  
  21.                     var properties = data.d.UserProfileProperties.results;  
  22.                     for (var i = 0; i < properties.length; i++) {  

  23.                         var property = properties[i];

  24.                         if (property.Key == "WorkEmail") {  
  25.                             workEmail = property.Value;  
  26.                         }  
  27.                          
  28.                         if (property.Key == "EmployeeID") {  
  29.                             EmployeeID = property.Value;  
  30.                         }  
  31.                         if (property.Key == "Division") {  
  32.                             Division = property.Value;  
  33.                         }  
  34.   
  35.                     }  
  36.                     $('#AccountName').text(AccountName);  
  37.                     $('#userDisplayName').text(userDisplayName);  
  38.                     $('#EmployeeID').text(EmployeeID);  
  39.                     $('#workEmail').text(workEmail);  
  40.                     $('#Division').text(Division);  
  41.                     
  42.   
  43.                 } catch (err2) {  
  44.                     //alert(JSON.stringify(err2));  
  45.                 }  
  46.             },  
  47.             error: function (jQxhr, errorCode, errorThrown) {  
  48.                 alert(errorThrown);  
  49.             }  
  50.         });  
  51.   
  52.     </script>  
  53.      
  54.     <h2><strong>Employee Details</strong></h2>  
  55.     <br />  
  56.     AccountName   <span id="AccountName"></span>  
  57.     DisplayName   <span id="userDisplayName"></span>  
  58.     EmployeeID    <span id="EmployeeID"></span>  
  59.     Email Address <span id="workEmail"></span>  
  60.     Division      <span id="Division"></span>  

User Properties

The following is the list of User Properties (use the GetPropertiesFor function for these):

AccountName
DirectReports
DisplayName
Email
ExtendedManagers
ExtendedReports
IsFollowed
LatestPost
Peers
PersonalUrl
PictureUrl
Title
UserProfileProperties
UserUrl

User Profile Properties

The following is the list of User Profile Properties:

AboutMe

SPS: LastKeywordAdded
AccountName

SPS: Locale
ADGuid

SPS: Location
Assistant

SPS: MasterAccountName
CellPhone

SPS: MemberOf
Department

SPS: MUILanguages
EduExternalSyncState

SPS: MySiteUpgrade
EduOAuthTokenProviders

SPS: O15FirstRunExperience
EduPersonalSiteState

SPS: ObjectExists
EduUserRole

SPS: OWAUrl
Fax

SPS: PastProjects
FirstName

SPS: Peers
HomePhone

SPS: PersonalSiteCapabilities
LastName

SPS: PersonalSiteInstantiationState
Manager

SPS: PhoneticDisplayName
Office

SPS: PhoneticFirstName
PersonalSpace

SPS: PhoneticLastName
PictureURL

SPS: PrivacyActivity
PreferredName

SPS: PrivacyPeople
PublicSiteRedirect

SPS: ProxyAddresses
QuickLinks

SPS: RegionalSettings:FollowWeb
SID

SPS: RegionalSettings:Initialized
SISUserId

SPS: ResourceAccountName

SPS: AdjustHijriDays


SPS: ResourceSID

SPS: AltCalendarType

SPS: Responsibility

SPS: Birthday

SPS: SavedAccountName

SPS: CalendarType

SPS: SavedSID

SPS: ClaimID

SPS: School

SPS: ClaimProviderID

SPS: ShowWeeks

SPS: ClaimProviderType

SPS:SipAddress

SPS:ContentLanguages

SPS:Skills

SPS:DataSource

SPS:SourceObjectDN

SPS:Department

SPS:StatusNotes

SPS:DisplayOrder

SPS:Time24

SPS:DistinguishedName

SPS:TimeZone

SPS:DontSuggestList

SPS: UserPrincipalName

SPS:Dotted:line

SPS:WorkDayEndHour

SPS:EmailOptin

SPS:WorkDayStartHour

SPS:FeedIdentifier

SPS:WorkDays

SPS:FirstDayOfWeek

Title

SPS:FirstWeekOfYear
UserName

SPS:HashTags
UserProfile_GUID

SPS:HireDate
WebSite

SPS:Interests
WorkEmail

SPS:JobTitle
WorkPhone

SPS:LastColleagueAdded