Get User Profile Field REST Endpoint

GET api/v2/userprofilefields/{name}.{json|xml}

Scopes

Users › Read Profile Fields users.profilefields.readonly

Request Parameters

Name	Type	Location	Description	Required	Default	Options
Name	string	Query String	User profile field name	Required

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api/v2/userprofilefields/{name}.json',
	data: { 
		'name': 'name'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "UserProfileField": {"Name":"name","Title":"title","RawTitle":"rawtitle","IsSearchable":true,"FieldType":{"Id":6,"Name":"name","IsSearchable":true,"IsMultipleChoice":true},"FieldTypeChoices":[{"Label":"label","Value":"value"},{"Label":"label","Value":"value"}]},
  "Errors": ["string","string"]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <UserProfileField>
    <Name>name</Name>
    <Title>title</Title>
    <RawTitle>rawtitle</RawTitle>
    <IsSearchable>true</IsSearchable>
    <FieldType>
      <Id>6</Id>
      <Name>name</Name>
      <IsSearchable>true</IsSearchable>
      <IsMultipleChoice>true</IsMultipleChoice>
    </FieldType>
    <FieldTypeChoices>
      <label>value</label>
      <label>value</label>
    </FieldTypeChoices>
  </UserProfileField>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

Recommended