People

Search, read and manage the people directory — the user profiles in your intranet.

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/find
GET /api/people/me
GET /api/people/{id}
GET /api/people/{id}/profile
GET /api/people/{personId}/team
POST /api/people
PUT /api/people/{personId}/profile-picture
GET /api/people/basic/{id}
GET /api/people/{id}/profile-fields
GET /api/people/{id}/profile-fields/additional

GET /api/people/find

Get a detailed profile of a specific person

Parameters

Name	In	Type	Required	Description
`username`	query	string	No
`email`	query	string	No

Responses

Status	Body
200	See below
400
404

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"
}

Field	Type
`Id`	integer (int32)
`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`	boolean
`Followers`	integer (int32)
`Following`	integer (int32)
`InfluenceScore`	integer (int32)
`IsMe`	boolean
`AssetId`	integer (int32)
`ImageUrl`	string
`ExpertiseUrl`	string
`InterestsUrl`	string
`FollowersUrl`	string
`AdditionalFields`	object
`AdditionalFieldsDetailed`	array of object
`ManagerId`	integer (int32)
`IsPowerUser`	boolean
`LanguageId`	integer (int32)
`CultureInfo`	string
`LanguagePreferenceCode`	string

GET /api/people/me

Gets details about the currently authenticated user.

Responses

Status	Body
200	See below
404

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"
}

Field	Type
`Id`	integer (int32)
`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`	boolean
`Followers`	integer (int32)
`Following`	integer (int32)
`InfluenceScore`	integer (int32)
`IsMe`	boolean
`AssetId`	integer (int32)
`ImageUrl`	string
`ExpertiseUrl`	string
`InterestsUrl`	string
`FollowersUrl`	string
`AdditionalFields`	object
`AdditionalFieldsDetailed`	array of object
`ManagerId`	integer (int32)
`IsPowerUser`	boolean
`LanguageId`	integer (int32)
`CultureInfo`	string
`LanguagePreferenceCode`	string

GET /api/people/{id}

Get details about a person from their Id.

Parameters

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

Responses

Status	Body
200	See below
404

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"
}

Field	Type
`Id`	integer (int32)
`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`	boolean
`Followers`	integer (int32)
`Following`	integer (int32)
`InfluenceScore`	integer (int32)
`IsMe`	boolean
`AssetId`	integer (int32)
`ImageUrl`	string
`ExpertiseUrl`	string
`InterestsUrl`	string
`FollowersUrl`	string
`AdditionalFields`	object
`AdditionalFieldsDetailed`	array of object
`ManagerId`	integer (int32)
`IsPowerUser`	boolean
`LanguageId`	integer (int32)
`CultureInfo`	string
`LanguagePreferenceCode`	string

GET /api/people/{id}/profile

Get a detailed profile of a specific person

Parameters

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

Responses

Status	Body
200	See below
400
404
410

Response body

{
  "HttpStatusCode": "Continue",
  "Message": "string",
  "Id": 0,
  "Title": "string",
  "FirstName": "string",
  "LastName": "string",
  "Pronouns": "string",
  "FullName": "string",
  "JobTitle": "string",
  "PrimaryDepartment": "string",
  "PrimaryLocation": "string",
  "PrimaryCompany": "string",
  "HomePhoneNumber": "string",
  "WorkPhone": "string",
  "Mobile": "string",
  "Extension": "string",
  "Fax": "string",
  "HomeAddress": "string",
  "Email": "string",
  "AlternativeEmailAddress": "string",
  "Bio": "string",
  "IsFollowing": true,
  "InfluenceScore": 0,
  "IsMe": true,
  "AssetId": 0,
  "ManagerId": 0,
  "ImageUrl": "string",
  "Timezone": "string",
  "TimezoneIanaCode": "string",
  "SkypeId": "string",
  "LinkedInId": "string",
  "FacebookId": "string",
  "TwitterTag": "string",
  "InstagramTag": "string",
  "JobStartDate": "2024-01-01T00:00:00Z",
  "JobEndDate": "2024-01-01T00:00:00Z",
  "Expertise": [
    {
      "SkillId": 0,
      "Title": "string",
      "AssetId": 0,
      "AssetDescription": "string",
      "Category": "string",
      "Endorsements": 0
    }
  ],
  "Interests": [
    {
      "SkillId": 0,
      "Title": "string",
      "AssetId": 0,
      "AssetDescription": "string",
      "Category": "string"
    }
  ],
  "Followers": [
    {
      "PersonId": 0,
      "FullName": "string",
      "AssetId": 0,
      "JobTitle": "string"
    }
  ],
  "Following": [
    {
      "PersonId": 0,
      "FullName": "string",
      "AssetId": 0,
      "JobTitle": "string"
    }
  ],
  "AdditionalFields": {},
  "AdditionalFieldsDetailed": [
    {
      "Label": "string",
      "Value": {},
      "Type": "TextField",
      "AssetId": 0
    }
  ],
  "FollowersCount": 0,
  "FollowingCount": 0,
  "ProfileComplete": 0,
  "CanEdit": true,
  "CanViewBlog": true,
  "BannerAssetId": 0,
  "CultureInfo": "string",
  "LanguageId": 0,
  "LanguageCode": "string",
  "IsPowerUser": true,
  "Personas": [
    {
      "Id": 0,
      "Title": "string"
    }
  ]
}

Field	Type
`HttpStatusCode`	string
`Message`	string
`Id`	integer (int32)
`Title`	string
`FirstName`	string
`LastName`	string
`Pronouns`	string
`FullName`	string
`JobTitle`	string
`PrimaryDepartment`	string
`PrimaryLocation`	string
`PrimaryCompany`	string
`HomePhoneNumber`	string
`WorkPhone`	string
`Mobile`	string
`Extension`	string
`Fax`	string
`HomeAddress`	string
`Email`	string
`AlternativeEmailAddress`	string
`Bio`	string
`IsFollowing`	boolean
`InfluenceScore`	integer (int32)
`IsMe`	boolean
`AssetId`	integer (int32)
`ManagerId`	integer (int32)
`ImageUrl`	string
`Timezone`	string
`TimezoneIanaCode`	string
`SkypeId`	string
`LinkedInId`	string
`FacebookId`	string
`TwitterTag`	string
`InstagramTag`	string
`JobStartDate`	string (date-time)
`JobEndDate`	string (date-time)
`Expertise`	array of object
`Interests`	array of object
`Followers`	array of object
`Following`	array of object
`AdditionalFields`	object
`AdditionalFieldsDetailed`	array of object
`FollowersCount`	integer (int32)
`FollowingCount`	integer (int32)
`ProfileComplete`	integer (int32)
`CanEdit`	boolean
`CanViewBlog`	boolean
`BannerAssetId`	integer (int32)
`CultureInfo`	string
`LanguageId`	integer (int32)
`LanguageCode`	string
`IsPowerUser`	boolean
`Personas`	array of object

GET /api/people/{personId}/team

Gets the teams for the specified person.

Parameters

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

Responses

Status	Body
200	See below

Response body

{
  "StatusCode": "Continue",
  "Items": [
    {
      "TeamId": 0,
      "Name": "string",
      "MemberCount": 0,
      "TeamAssetId": 0,
      "MembershipTypeName": "string",
      "Url": "string",
      "SectionId": 0
    }
  ],
  "ErrorMessages": [
    "string"
  ]
}

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

POST /api/people

Performs an advanced search allowing custom filters to be provided

Request body

{
  "SearchTerm": "string",
  "AlphabetFilter": "string",
  "Department": "string",
  "ManagerId": 0,
  "Limit": 0,
  "Offset": 0,
  "SortBy": "string",
  "Expertise": [
    "string"
  ],
  "Interests": [
    "string"
  ],
  "CustomFields": [
    {
      "Name": "string",
      "Key": "string",
      "Value": "string",
      "ValueInt": 0
    }
  ],
  "UserFilters": [
    {
      "Name": "string",
      "Facet": "string"
    }
  ],
  "AllowedPersonIds": [
    0
  ],
  "IncludeAdditionalGroups": true,
  "SearchType": "string",
  "JobTitle": "string",
  "PhoneNumber": "string",
  "AdditionalDepartmentId": "string",
  "AdditionalCompanyId": "string",
  "AdditionalLocationId": "string",
  "ShowEveryoneFilter": true,
  "KeepSearchFilters": true,
  "CurrentPage": 0,
  "PageLucene": true,
  "UtmMedium": "string",
  "NameOnly": true
}

Field	Type
`SearchTerm`	string
`AlphabetFilter`	string
`Department`	string
`ManagerId`	integer (int32)
`Limit`	integer (int32)
`Offset`	integer (int32)
`SortBy`	string
`Expertise`	array of string
`Interests`	array of string
`CustomFields`	array of object
`UserFilters`	array of object
`AllowedPersonIds`	array of integer
`IncludeAdditionalGroups`	boolean
`SearchType`	string
`JobTitle`	string
`PhoneNumber`	string
`AdditionalDepartmentId`	string
`AdditionalCompanyId`	string
`AdditionalLocationId`	string
`ShowEveryoneFilter`	boolean
`KeepSearchFilters`	boolean
`CurrentPage`	integer (int32)
`PageLucene`	boolean
`UtmMedium`	string
`NameOnly`	boolean

Responses

Status	Body
200	See below
400

Response body

{
  "TotalResults": 0,
  "Limit": 0,
  "Offset": 0,
  "Results": [
    {
      "Id": 0,
      "FullName": "string",
      "LastName": "string",
      "FirstName": "string",
      "IsMe": true,
      "AssetId": 0,
      "Email": "string",
      "JobDescription": "string",
      "Manager": "string",
      "PrimaryDepartment": "string",
      "PrimaryCompany": "string",
      "PrimaryLocation": "string",
      "Extension": "string",
      "WorkPhone": "string",
      "Mobile": "string",
      "JobTitle": "string",
      "ImageUrl": "string",
      "ExpertiseUrl": "string",
      "InterestsUrl": "string",
      "FollowersUrl": "string",
      "QueryStringUtmParameters": "string"
    }
  ],
  "Filters": [
    {
      "Name": "string",
      "Label": "string",
      "Facets": [
        {
          "Name": "string",
          "Count": 0,
          "Selected": true
        }
      ]
    }
  ]
}

Field	Type
`TotalResults`	integer (int32)
`Limit`	integer (int32)
`Offset`	integer (int32)
`Results`	array of object
`Filters`	array of object

PUT /api/people/{personId}/profile-picture

Set Profile Picture

Parameters

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

Request body

{
  "Id": 0,
  "FirstName": "string",
  "LastName": "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"
}

Field	Type
`Id`	integer (int32)
`FirstName`	string
`LastName`	string
`FullName`	string
`JobTitle`	string
`PrimaryDepartment`	string
`PrimaryLocation`	string
`PrimaryCompany`	string
`WorkPhone`	string
`Mobile`	string
`Extension`	string
`Email`	string
`IsFollowing`	boolean
`Followers`	integer (int32)
`Following`	integer (int32)
`InfluenceScore`	integer (int32)
`IsMe`	boolean
`AssetId`	integer (int32)
`ImageUrl`	string
`ExpertiseUrl`	string
`InterestsUrl`	string
`FollowersUrl`	string

Responses

Status	Body
200	boolean
403
404

GET /api/people/basic/{id}

Get basic details about a person from their Id.

Parameters

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

Responses

Status	Body
200	See below
404

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"
}

Field	Type
`Id`	integer (int32)
`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`	boolean
`Followers`	integer (int32)
`Following`	integer (int32)
`InfluenceScore`	integer (int32)
`IsMe`	boolean
`AssetId`	integer (int32)
`ImageUrl`	string
`ExpertiseUrl`	string
`InterestsUrl`	string
`FollowersUrl`	string
`AdditionalFields`	object
`AdditionalFieldsDetailed`	array of object
`ManagerId`	integer (int32)
`IsPowerUser`	boolean
`LanguageId`	integer (int32)
`CultureInfo`	string
`LanguagePreferenceCode`	string

GET /api/people/{id}/profile-fields

Gets the profile for the specified person. Fields returned are based on profile field permissions.

Parameters

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

Responses

Status	Body
200	See below
204
404

Response body

{
  "StatusCode": "Continue",
  "Items": [
    {
      "FieldId": 0,
      "Key": "string",
      "Type": "string",
      "CanEdit": true,
      "Field": {
        "Label": "string",
        "AdditionalFieldType": "string"
      },
      "AssetId": 0
    }
  ],
  "ErrorMessages": [
    "string"
  ]
}

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

GET /api/people/{id}/profile-fields/additional

Gets additional profile fields for the specified person. Fields returned are based on profile field permissions.

Parameters

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

Responses

Status	Body
200	See below
204
404

Response body

{
  "StatusCode": "Continue",
  "Items": [
    {
      "FieldId": 0,
      "Key": "string",
      "Type": "string",
      "CanEdit": true,
      "Field": {
        "Label": "string",
        "AdditionalFieldType": "string"
      },
      "AssetId": 0
    }
  ],
  "ErrorMessages": [
    "string"
  ]
}

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

Section: REST API