List User Profile Field REST Endpoint

Former Member — Fri, 13 May 2022 19:38:43 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:38:43

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

Scopes

Users › Read Profile Fields users.profilefields.readonly

Request Parameters

Name	Type	Location	Description	Required
IsSearchable	bool	Query String	Filter by searchable fields	Optional
PageIndex	int	Query String	Page of results to return	Optional
PageSize	int	Query String	Number of results to return	Optional
UserProfileFieldGroupId	int	Query String	Profile Field Group Id to filter fields	Optional

Example Requests

Widget Javascript

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

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "UserProfileFields": [
    {
      "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"
        }
      ]
    },
    {
      "Name": "name",
      "Title": "title",
      "RawTitle": "rawtitle",
      "IsSearchable": true,
      "FieldType": {
        "Id": 25,
        "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>
  <UserProfileFields PageSize="2" PageIndex="0" TotalCount="2">
    <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>
    <UserProfileField>
      <Name>name</Name>
      <Title>title</Title>
      <RawTitle>rawtitle</RawTitle>
      <IsSearchable>true</IsSearchable>
      <FieldType>
        <Id>25</Id>
        <Name>name</Name>
        <IsSearchable>true</IsSearchable>
        <IsMultipleChoice>true</IsMultipleChoice>
      </FieldType>
      <FieldTypeChoices>
        <label>value</label>
        <label>value</label>
      </FieldTypeChoices>
    </UserProfileField>
  </UserProfileFields>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>