Loading ...

REST API: Get Me | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get Me
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Me

0 
 /5
0 (0votes)

Get Me

GET /api/users/me

Get the current user's profile data. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
LogView &logView=true - Used in the request URL as a query parameter Logs the API call as an action in User Activity when set to true

Example Request

GET https://myintranet.communifire.com/api/users/me

Example Response

User JSON object is returned as ResponseData.

{
  
    "UserName": "Alice",
    "MediaServerRootURL": "https://graphix.com/Assets/Uploaded-Photos",
    "MediaServerID": 76,
    "FirstName": "Alice",
    "LastName": "Romero",
    "MiddleName": "Claire",
    "ProfileURL": "https://graphix/people/Alice",
    "ConnectionStatus": 0,
    "Occupation": "Motion Graphic Designer",
    "UserID": 1376,
    "UserInfoDisplayName": "Alice Romero",
    "Email": "alice@graphix.com",
    "AvatarImageURL": "https://graphicx.com/Assets/Uploaded-Photos/377/8ca12e5a-9665-49b3-9dfb-84f987d3c908.jpg",
    "IsCommunityUser": false,
    "TenantID": 0
  }
}

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software