Loading ...

REST API: Get User's Profile Fields | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get User's Profile Fields
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 8

REST API: Get User's Profile Fields

0 
 /5
0 (0votes)

Get user's profile fields

GET /api/content/{userid}

Get user profile fields for a particular user. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 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.
UserID Used in the request URL (see below)

Unique identifier for a particular user.
ContentTypeID &contentTypeID=15 - Used in the request URL (see below) The content type ID for User is 15 and it is constant.
Fields &fields=x - Used in the request URL (see below) A CSV list of the field labels. The field labels are case sensitive.

Example URL to GET: https://your-community.com/api/content/38?contentTypeID=15&fields=Company,Occupation,Department,Reports%20to

Response JSON sample where user JSON object is returned as ResponseData

Here is an example of JSON data returned from the API call.

{
   "IsError": false,
   "ResponseMessage": "",
   "ResponseData": {
      "Company": "Axero Solutions",
      "Occupation": "HR Manager",
      "Department": "Human Resources",
      "Reports to": "12"
   }
}

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

 

Wiki Index

Pages

Intranet Software