HomeREST APIFollowers

Followers

Reference for the followers 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/people/{id}/following

Get list of people a specific person is following

Parameters

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

Responses

Status Body
200 See below
404

Response body

[
  {
    "PersonId": 0,
    "FullName": "string",
    "AssetId": 0,
    "JobTitle": "string"
  }
]
FieldType
PersonIdinteger (int32)
FullNamestring
AssetIdinteger (int32)
JobTitlestring

GET /api/people/{id}/followers

Get list of followers for specific person

Parameters

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

Responses

Status Body
200 See below
404

Response body

[
  {
    "PersonId": 0,
    "FullName": "string",
    "AssetId": 0,
    "JobTitle": "string"
  }
]
FieldType
PersonIdinteger (int32)
FullNamestring
AssetIdinteger (int32)
JobTitlestring

PUT /api/people/followers/{followerId}

Follow a new person

Parameters

Name In Type Required Description
followerId path integer (int32) Yes

Responses

Status Body
200 See below
400

Response body

{
  "Id": 0,
  "FirstName": "string",
  "LastName": "string",
  "Pronouns": "string",
  "FullName": "string",
  "JobTitle": "string",
  "PrimaryDepartment": "string",
  "PrimaryLocation": "string",
  "PrimaryCompany": "string",
  "WorkPhone": "string",
  "Mobile": "string",
  "Extension": "string",
  "Email": "string",
  "IsFollowing": true,
  "Followers": 0,
  "Following": 0,
  "InfluenceScore": 0,
  "IsMe": true,
  "AssetId": 0,
  "ImageUrl": "string",
  "ExpertiseUrl": "string",
  "InterestsUrl": "string",
  "FollowersUrl": "string",
  "AdditionalFields": {},
  "AdditionalFieldsDetailed": [
    {
      "Label": "string",
      "Value": {},
      "Type": "TextField",
      "AssetId": 0
    }
  ],
  "ManagerId": 0,
  "IsPowerUser": true,
  "LanguageId": 0,
  "CultureInfo": "string",
  "LanguagePreferenceCode": "string"
}
FieldType
Idinteger (int32)
FirstNamestring
LastNamestring
Pronounsstring
FullNamestring
JobTitlestring
PrimaryDepartmentstring
PrimaryLocationstring
PrimaryCompanystring
WorkPhonestring
Mobilestring
Extensionstring
Emailstring
IsFollowingboolean
Followersinteger (int32)
Followinginteger (int32)
InfluenceScoreinteger (int32)
IsMeboolean
AssetIdinteger (int32)
ImageUrlstring
ExpertiseUrlstring
InterestsUrlstring
FollowersUrlstring
AdditionalFieldsobject
AdditionalFieldsDetailedarray of object
ManagerIdinteger (int32)
IsPowerUserboolean
LanguageIdinteger (int32)
CultureInfostring
LanguagePreferenceCodestring

DELETE /api/people/followers/{followerId}

Unfollow a person you are currently following

Parameters

Name In Type Required Description
followerId path integer (int32) Yes

Responses

Status Body
200 See below
400

Response body

{
  "Id": 0,
  "FirstName": "string",
  "LastName": "string",
  "Pronouns": "string",
  "FullName": "string",
  "JobTitle": "string",
  "PrimaryDepartment": "string",
  "PrimaryLocation": "string",
  "PrimaryCompany": "string",
  "WorkPhone": "string",
  "Mobile": "string",
  "Extension": "string",
  "Email": "string",
  "IsFollowing": true,
  "Followers": 0,
  "Following": 0,
  "InfluenceScore": 0,
  "IsMe": true,
  "AssetId": 0,
  "ImageUrl": "string",
  "ExpertiseUrl": "string",
  "InterestsUrl": "string",
  "FollowersUrl": "string",
  "AdditionalFields": {},
  "AdditionalFieldsDetailed": [
    {
      "Label": "string",
      "Value": {},
      "Type": "TextField",
      "AssetId": 0
    }
  ],
  "ManagerId": 0,
  "IsPowerUser": true,
  "LanguageId": 0,
  "CultureInfo": "string",
  "LanguagePreferenceCode": "string"
}
FieldType
Idinteger (int32)
FirstNamestring
LastNamestring
Pronounsstring
FullNamestring
JobTitlestring
PrimaryDepartmentstring
PrimaryLocationstring
PrimaryCompanystring
WorkPhonestring
Mobilestring
Extensionstring
Emailstring
IsFollowingboolean
Followersinteger (int32)
Followinginteger (int32)
InfluenceScoreinteger (int32)
IsMeboolean
AssetIdinteger (int32)
ImageUrlstring
ExpertiseUrlstring
InterestsUrlstring
FollowersUrlstring
AdditionalFieldsobject
AdditionalFieldsDetailedarray of object
ManagerIdinteger (int32)
IsPowerUserboolean
LanguageIdinteger (int32)
CultureInfostring
LanguagePreferenceCodestring
Section: REST API