Person profile

Reference for the person profile 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/person-profile/field-settings
GET /api/person-profile/{personId}
POST /api/person-profile
PUT /api/person-profile/{userId}
PUT /api/person-profile/{userId}/active
PATCH /api/person-profile/me
PATCH /api/person-profile/{userId}
DELETE /api/person-profile/{personId}

GET /api/person-profile/field-settings

List field settings.

Responses

Status	Body
200	See below

Response body

{
  "StatusCode": "Continue",
  "Items": [
    {
      "FieldID": 0,
      "Title": "string",
      "AllowEdit": true,
      "AllowView": true,
      "IncludeScore": true,
      "IncludeIntersitial": true
    }
  ],
  "ErrorMessages": [
    "string"
  ]
}

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

GET /api/person-profile/{personId}

Get a person profile by ID.

🔒Access — Power user

Parameters

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

Responses

Status	Body
200	object

POST /api/person-profile

Create a person profile.

🔒Access — Power user

Request body

{
  "Username": "string",
  "Password": "string",
  "Title": "string",
  "FirstName": "string",
  "Surname": "string",
  "Email1": "string",
  "Email2": "string",
  "TypeId": 0,
  "DnField": "string",
  "IsBillingContact": true,
  "DomainId": 0,
  "OrganisationId": 0,
  "AboutMe": "string",
  "Active": true,
  "Address": "string",
  "AltManager": 0,
  "AssetId": 0,
  "Chat": "string",
  "ContactLocationId": 0,
  "CultureId": 0,
  "CultureAskedFlag": true,
  "DobEventDate": "2024-01-01T00:00:00Z",
  "EmployeeNumber": "string",
  "Extension": "string",
  "Fax": "string",
  "FacebookId": "string",
  "HomepageId": 0,
  "HomePhone": "string",
  "Initials": "string",
  "InstagramTag": "string",
  "IsDebug": true,
  "JobDescription": "string",
  "JobTitle": "string",
  "LicenseType": 0,
  "LinkedInId": "string",
  "ManagerUsername": "string",
  "Mobile": "string",
  "Notes": "string",
  "NtUsername": "string",
  "Website": "string",
  "WorkPhone": "string",
  "ContactCompany": "string",
  "ForcePassword": true,
  "PersonaOrgId": 0,
  "PostCode": "string",
  "Profile": "string",
  "RealTimeStatus": 0,
  "RealTimeDesc": "string",
  "ReviewEventId": 0,
  "Salary": "string",
  "SocialHomepageId": 0,
  "TwitterTag": "string",
  "JobStart": "2024-01-01T00:00:00Z",
  "JobEnd": "2024-01-01T00:00:00Z",
  "Skype": "string",
  "ThemeId": 0,
  "Timezone": "string",
  "ProfileComplete": 0,
  "LoginType": 0,
  "SiteId": 0,
  "UmiUid": "string",
  "DayLightSavingTime": true,
  "StyleSheetId": 0,
  "IgnoreAaForWysiwyg": true,
  "JawsUser": true,
  "Bandwidth": 0,
  "Language": 0,
  "Translator": true,
  "DocumentAddMethod": 0,
  "Sync": true,
  "CompanyName": "string",
  "PrimaryDepartmentName": "string",
  "PrimaryLocationName": "string",
  "AdditionalCompanies": [
    "string"
  ],
  "AdditionalDepartments": [
    "string"
  ],
  "AdditionalLocations": [
    "string"
  ],
  "Status": "string"
}

Field	Type
`Username`	string
`Password`	string
`Title`	string
`FirstName`	string
`Surname`	string
`Email1`	string
`Email2`	string
`TypeId`	integer (int32)
`DnField`	string
`IsBillingContact`	boolean
`DomainId`	integer (int32)
`OrganisationId`	integer (int32)
`AboutMe`	string
`Active`	boolean
`Address`	string
`AltManager`	integer (int32)
`AssetId`	integer (int32)
`Chat`	string
`ContactLocationId`	integer (int32)
`CultureId`	integer (int32)
`CultureAskedFlag`	boolean
`DobEventDate`	string (date-time)
`EmployeeNumber`	string
`Extension`	string
`Fax`	string
`FacebookId`	string
`HomepageId`	integer (int32)
`HomePhone`	string
`Initials`	string
`InstagramTag`	string
`IsDebug`	boolean
`JobDescription`	string
`JobTitle`	string
`LicenseType`	integer (int32)
`LinkedInId`	string
`ManagerUsername`	string
`Mobile`	string
`Notes`	string
`NtUsername`	string
`Website`	string
`WorkPhone`	string
`ContactCompany`	string
`ForcePassword`	boolean
`PersonaOrgId`	integer (int32)
`PostCode`	string
`Profile`	string
`RealTimeStatus`	integer (int32)
`RealTimeDesc`	string
`ReviewEventId`	integer (int32)
`Salary`	string
`SocialHomepageId`	integer (int32)
`TwitterTag`	string
`JobStart`	string (date-time)
`JobEnd`	string (date-time)
`Skype`	string
`ThemeId`	integer (int32)
`Timezone`	string
`ProfileComplete`	number (float)
`LoginType`	integer (int32)
`SiteId`	integer (int32)
`UmiUid`	string
`DayLightSavingTime`	boolean
`StyleSheetId`	integer (int32)
`IgnoreAaForWysiwyg`	boolean
`JawsUser`	boolean
`Bandwidth`	integer (int32)
`Language`	integer (int32)
`Translator`	boolean
`DocumentAddMethod`	integer (int32)
`Sync`	boolean
`CompanyName`	string
`PrimaryDepartmentName`	string
`PrimaryLocationName`	string
`AdditionalCompanies`	array of string
`AdditionalDepartments`	array of string
`AdditionalLocations`	array of string
`Status`	string

Responses

Status	Body
200	object

PUT /api/person-profile/{userId}

Update a person profile.

🔒Access — Power user

Parameters

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

Request body

{
  "UserId": 0,
  "FirstName": "string",
  "LanguageId": 0
}

Field	Type
`UserId`	integer (int32)
`FirstName`	string
`LanguageId`	integer (int32)

Responses

Status	Body
200	object

PUT /api/person-profile/{userId}/active

Update the active status of the person profile.

🔒Access — Power user

Parameters

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

Request body

{
  "Active": true
}

Field	Type
`Active`	boolean

Responses

Status	Body
200	object

PATCH /api/person-profile/me

Update a me.

Request body

{
  "Patches": [
    {
      "Key": "string",
      "Value": {}
    }
  ]
}

Field	Type
`Patches`	array of object

Responses

Status	Body
200	object

PATCH /api/person-profile/{userId}

Update a person profile.

🔒Access — Power user

Parameters

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

Request body

{
  "Patches": [
    {
      "Key": "string",
      "Value": {}
    }
  ]
}

Field	Type
`Patches`	array of object

Responses

Status	Body
200	object

DELETE /api/person-profile/{personId}

Delete a person profile.

🔒Access — Power user

Parameters

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

Responses

Status	Body
200	object

Section: REST API