Documentation

API /user/{userId}/customfield/{customfieldgroup}/{customfieldname}

ThoughtFarmer REST API Method: /user/{userId}/customfield/{customfieldgroup}/{customfieldname}

Gets a custom field for a user. The templateId is the unique name of the custom field. eg. aboutme-twitter
 
URL:
http://yourserver.com/api/user/{userId}/customfield/{customfieldgroup}/{customfieldname}
http://yourserver.com/api/2.0/user/{userId}/customfield/{customfieldgroup}/{customfieldname}

Response Formats:
xml,json

HTTP Method(s):
GET
 
Requires Authentication:
true, user making call must pass a valid token parameter

Parameters:

 Parameter Type Description
userId int Required. The user id of the user to retrieve
customfieldgroup string Required. The group name of the custom field to retreive the data for
customfieldname string Required. The name of the custom field. This is the sanitized name of the custom field. e.g. a filed called Start Date would be santized to StartDate.
token string Required. A valid token authentication parameter
Response Status Codes:
200 - Success
400 - templateId is not valid or the group/field parts do not match an existing custom field
401 - Token parameter is invalid
403 - You do not have permission to view this user or you are trying to view a private custom field that does not belong to you
404 - User not found

Example request
GET http://yourserver.com/api/user/{userId}/customfield/{customfieldgroup}/{customfieldname}?token={token}
e.g. https://yourserver.com/api/user/1234/customfield/expertiseskills/languages
{
   "CustomFieldId":25,
   "Editable":true,
   "Label":[
      {
         "Key":"en",
         "Value":"Technical Skills"
      }
   ],
   "Name":"TechnicalSkills",
   "Type":5,
   "Value":""
}