Additional field

Reference for the additional 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/additional-fields
GET /api/additional-fields/{id}
POST /api/additional-fields/search

GET /api/additional-fields

Get a list of additional fields

🔒Access — Site admin

Parameters

Name	In	Type	Required
`searchTerm`	query	string	No
`order`	query	string	No
`active`	query	boolean	No
`offset`	query	integer (int32)	No
`limit`	query	integer (int32)	No

Responses

Status	Body
200	See below
400
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "Id": 0,
        "Title": "string",
        "Type": "TextField",
        "ContactField": true,
        "Rows": 0,
        "AssetId": 0,
        "Private": true,
        "Managers": true,
        "Hr": true,
        "UserEdit": true,
        "DisplayOnProfile": true,
        "Size": 0,
        "Active": true,
        "ContentField": true,
        "OrganisationId": 0,
        "Key": "string"
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}

Field	Type
`StatusCode`	string
`Page`	object
`ErrorMessages`	array of string

GET /api/additional-fields/{id}

Get an additional field by Id

🔒Access — Site admin

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Responses

Status	Body
200	See below
400
404
500

Response body

{
  "StatusCode": "Continue",
  "Item": {
    "Id": 0,
    "Title": "string",
    "Type": "TextField",
    "ContactField": true,
    "Rows": 0,
    "AssetId": 0,
    "Private": true,
    "Managers": true,
    "Hr": true,
    "UserEdit": true,
    "DisplayOnProfile": true,
    "Size": 0,
    "Active": true,
    "ContentField": true,
    "OrganisationId": 0,
    "Key": "string"
  },
  "ErrorMessages": [
    "string"
  ]
}

Field	Type
`StatusCode`	string
`Item`	object
`ErrorMessages`	array of string

POST /api/additional-fields/search

Get a list of additional fields based on the parameters of the search model provided NOTE this endpoint omits the Site Admin authorisation header is as required by people directory filters panel

Request body

{
  "SearchTerm": "string",
  "Order": "string",
  "Active": true,
  "Offset": 0,
  "Limit": 0,
  "OnlyDisplayedOnProfile": true,
  "IncludePrivateFields": true
}

Field	Type
`SearchTerm`	string
`Order`	string
`Active`	boolean
`Offset`	integer (int32)
`Limit`	integer (int32)
`OnlyDisplayedOnProfile`	boolean
`IncludePrivateFields`	boolean

Responses

Status	Body
200	See below
400
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "Id": 0,
        "Title": "string",
        "Type": "TextField",
        "ContactField": true,
        "Rows": 0,
        "AssetId": 0,
        "Private": true,
        "Managers": true,
        "Hr": true,
        "UserEdit": true,
        "DisplayOnProfile": true,
        "Size": 0,
        "Active": true,
        "ContentField": true,
        "OrganisationId": 0,
        "Key": "string"
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}

Field	Type
`StatusCode`	string
`Page`	object
`ErrorMessages`	array of string

Section: REST API