Profile field

Reference for the profile field endpoints of the Interact REST API.

Note: All endpoints require authentication and an X-Tenant header. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.

Endpoints on this page

GET /api/profile-fields

GET /api/profile-fields

Get a list of profile fields

🔒Access — Site admin

Responses

Status	Body
200	See below
400
500

Response body

{
  "StatusCode": "Continue",
  "Result": {
    "Id": 0,
    "Name": "string",
    "Label": "string",
    "Access": 0,
    "AccessDisabled": [
      0
    ],
    "IncludeScore": true,
    "IncludeIntersitial": true,
    "Ordering": 0,
    "CacheKey": "string",
    "ControlType": 0,
    "IncludeScoreAvailability": 0,
    "GroupAllocationAllowed": true
  },
  "TotalResults": 0,
  "Page": 0,
  "Size": 0
}

Field	Type
`StatusCode`	string
`Result`	object
`TotalResults`	integer (int32)
`Page`	integer (int32)
`Size`	integer (int32)

Section: REST API