GET api/v2.0/Friends/GetPendingReceivedFriendRequests

Gets a List of FriendModel objects representing the pending Friend Requests that the Current User has RECEIVED.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

An array of FriendModel objects.

Collection of Friend

Name	Description	Type	Additional information
FirstName	If the Current Contact is the SENDER of the Friend Request, the RECIPIENT's first name. If the Current Contact is the RECIPIENT of the Friend Request, the SENDER's first name.	string	Required
LastName	If the Current Contact is the SENDER of the Friend Request, the RECIPIENT's last name. If the Current Contact is the RECIPIENT of the Friend Request, the SENDER's last name.	string	Required
DisplayName	If the Current Contact is the SENDER of the Friend Request, the RECIPIENT's display name. If the Current Contact is the RECIPIENT of the Friend Request, the SENDER's display name.	string	Required
LinkToProfile	If the Current Contact is the SENDER of the Friend Request, the link to the RECIPIENT's profile page. If the Current Contact is the RECIPIENT of the Friend Request, the link to the SENDER's profile page.	string	None.
LinkToSmallImage	If the Current Contact is the SENDER of the Friend Request, the link to the RECIPIENT's small image. If the Current Contact is the RECIPIENT of the Friend Request, the link to the SENDER's small image.	string	None.
LinkToLargeImage	If the Current Contact is the SENDER of the Friend Request, the link to the RECIPIENT's large image. If the Current Contact is the RECIPIENT of the Friend Request, the link to the SENDER's large image.	string	None.
IsCompany	If the Current Contact is the SENDER of the Friend Request, if the RECIPIENT is a company. If the Current Contact is the RECIPIENT of the Friend Request, if the SENDER is a company.	boolean	None.
FriendRequestRecordKey	Unique Identifier for the friend request.	globally unique identifier	None.
IsActive	If the friend request is active.	boolean	None.
RequestorContactKey	This field is deprecated, please use RequestedByContactKey instead.	globally unique identifier	None.
RequestedByContactKey	Contact key of the user who initiated the friend request.	globally unique identifier	None.
RequesteeContactKey	Contact key of the user who received the friend request.	globally unique identifier	None.
InvitedOn	DateTime of when friend invite was sent.	date	None.
AcceptedOn	DateTime of when friend invite was accepted. Null if not yet accepted	date	None.
RequestedDate	DateTime of when friend invite was created. Typically synonymous with InvitedOn.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "DisplayName": "sample string 3",
    "LinkToProfile": "sample string 4",
    "LinkToSmallImage": "sample string 5",
    "LinkToLargeImage": "sample string 6",
    "IsCompany": true,
    "FriendRequestRecordKey": "72dcabbb-c1ea-44f8-a13f-37dd0969f871",
    "IsActive": true,
    "RequestorContactKey": "6599c809-c783-41d1-b216-6a8ce3af4e13",
    "RequestedByContactKey": "727416ea-3f81-40c5-9b71-4785248fb9fa",
    "RequesteeContactKey": "ecb33add-b02a-45a6-bb05-caf63ad539ff",
    "InvitedOn": "2024-12-26T11:04:50.2371105Z",
    "AcceptedOn": "2024-12-26T11:04:50.2371105Z",
    "RequestedDate": "2024-12-26T11:04:50.2371105Z"
  },
  {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "DisplayName": "sample string 3",
    "LinkToProfile": "sample string 4",
    "LinkToSmallImage": "sample string 5",
    "LinkToLargeImage": "sample string 6",
    "IsCompany": true,
    "FriendRequestRecordKey": "72dcabbb-c1ea-44f8-a13f-37dd0969f871",
    "IsActive": true,
    "RequestorContactKey": "6599c809-c783-41d1-b216-6a8ce3af4e13",
    "RequestedByContactKey": "727416ea-3f81-40c5-9b71-4785248fb9fa",
    "RequesteeContactKey": "ecb33add-b02a-45a6-bb05-caf63ad539ff",
    "InvitedOn": "2024-12-26T11:04:50.2371105Z",
    "AcceptedOn": "2024-12-26T11:04:50.2371105Z",
    "RequestedDate": "2024-12-26T11:04:50.2371105Z"
  }
]

application/xml, text/xml

Sample:

<ArrayOfFriend xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <Friend>
    <AcceptedOn>2024-12-26T06:04:50.2371105-05:00</AcceptedOn>
    <DisplayName>sample string 3</DisplayName>
    <FirstName>sample string 1</FirstName>
    <FriendRequestRecordKey>72dcabbb-c1ea-44f8-a13f-37dd0969f871</FriendRequestRecordKey>
    <InvitedOn>2024-12-26T06:04:50.2371105-05:00</InvitedOn>
    <IsActive>true</IsActive>
    <IsCompany>true</IsCompany>
    <LastName>sample string 2</LastName>
    <LinkToLargeImage>sample string 6</LinkToLargeImage>
    <LinkToProfile>sample string 4</LinkToProfile>
    <LinkToSmallImage>sample string 5</LinkToSmallImage>
    <RequestedByContactKey>727416ea-3f81-40c5-9b71-4785248fb9fa</RequestedByContactKey>
    <RequestedDate>2024-12-26T06:04:50.2371105-05:00</RequestedDate>
    <RequesteeContactKey>ecb33add-b02a-45a6-bb05-caf63ad539ff</RequesteeContactKey>
    <RequestorContactKey>6599c809-c783-41d1-b216-6a8ce3af4e13</RequestorContactKey>
  </Friend>
  <Friend>
    <AcceptedOn>2024-12-26T06:04:50.2371105-05:00</AcceptedOn>
    <DisplayName>sample string 3</DisplayName>
    <FirstName>sample string 1</FirstName>
    <FriendRequestRecordKey>72dcabbb-c1ea-44f8-a13f-37dd0969f871</FriendRequestRecordKey>
    <InvitedOn>2024-12-26T06:04:50.2371105-05:00</InvitedOn>
    <IsActive>true</IsActive>
    <IsCompany>true</IsCompany>
    <LastName>sample string 2</LastName>
    <LinkToLargeImage>sample string 6</LinkToLargeImage>
    <LinkToProfile>sample string 4</LinkToProfile>
    <LinkToSmallImage>sample string 5</LinkToSmallImage>
    <RequestedByContactKey>727416ea-3f81-40c5-9b71-4785248fb9fa</RequestedByContactKey>
    <RequestedDate>2024-12-26T06:04:50.2371105-05:00</RequestedDate>
    <RequesteeContactKey>ecb33add-b02a-45a6-bb05-caf63ad539ff</RequesteeContactKey>
    <RequestorContactKey>6599c809-c783-41d1-b216-6a8ce3af4e13</RequestorContactKey>
  </Friend>
</ArrayOfFriend>