GET api/v2.0/Friends/GetPendingSentFriendRequests

Returns a List of FriendModel objects representing the pending Friend Requests that the Current User has SENT.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Friend
NameDescriptionTypeAdditional information
FirstName

string

Required

LastName

string

Required

DisplayName

string

Required

LinkToProfile

string

None.

LinkToSmallImage

string

None.

LinkToLargeImage

string

None.

IsCompany

boolean

None.

FriendRequestRecordKey

globally unique identifier

None.

RequestorContactKey

This field is deprecated, please use RequestedByContactKey instead.

globally unique identifier

None.

RequesteeContactKey

globally unique identifier

None.

RequestedByContactKey

globally unique identifier

None.

InvitedOn

date

None.

AcceptedOn

date

None.

IsActive

boolean

None.

RequestedDate

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": "320caa99-7913-454c-b771-1ab00128ed80",
    "RequestorContactKey": "0e4cbdd4-132f-4462-8a50-c9589f140b1a",
    "RequesteeContactKey": "ad54f3fe-0b4e-408d-842d-9ed4971bdea9",
    "RequestedByContactKey": "de11f5b3-ab4e-484e-a8fe-efaea431be06",
    "InvitedOn": "2019-07-21T08:57:53.9781337Z",
    "AcceptedOn": "2019-07-21T08:57:53.9781337Z",
    "IsActive": true,
    "RequestedDate": "2019-07-21T08:57:53.9781337Z"
  },
  {
    "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": "320caa99-7913-454c-b771-1ab00128ed80",
    "RequestorContactKey": "0e4cbdd4-132f-4462-8a50-c9589f140b1a",
    "RequesteeContactKey": "ad54f3fe-0b4e-408d-842d-9ed4971bdea9",
    "RequestedByContactKey": "de11f5b3-ab4e-484e-a8fe-efaea431be06",
    "InvitedOn": "2019-07-21T08:57:53.9781337Z",
    "AcceptedOn": "2019-07-21T08:57:53.9781337Z",
    "IsActive": true,
    "RequestedDate": "2019-07-21T08:57:53.9781337Z"
  }
]

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>2019-07-21T04:57:53.9781337-04:00</AcceptedOn>
    <DisplayName>sample string 3</DisplayName>
    <FirstName>sample string 1</FirstName>
    <FriendRequestRecordKey>320caa99-7913-454c-b771-1ab00128ed80</FriendRequestRecordKey>
    <InvitedOn>2019-07-21T04:57:53.9781337-04: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>de11f5b3-ab4e-484e-a8fe-efaea431be06</RequestedByContactKey>
    <RequestedDate>2019-07-21T04:57:53.9781337-04:00</RequestedDate>
    <RequesteeContactKey>ad54f3fe-0b4e-408d-842d-9ed4971bdea9</RequesteeContactKey>
    <RequestorContactKey>0e4cbdd4-132f-4462-8a50-c9589f140b1a</RequestorContactKey>
  </Friend>
  <Friend>
    <AcceptedOn>2019-07-21T04:57:53.9781337-04:00</AcceptedOn>
    <DisplayName>sample string 3</DisplayName>
    <FirstName>sample string 1</FirstName>
    <FriendRequestRecordKey>320caa99-7913-454c-b771-1ab00128ed80</FriendRequestRecordKey>
    <InvitedOn>2019-07-21T04:57:53.9781337-04: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>de11f5b3-ab4e-484e-a8fe-efaea431be06</RequestedByContactKey>
    <RequestedDate>2019-07-21T04:57:53.9781337-04:00</RequestedDate>
    <RequesteeContactKey>ad54f3fe-0b4e-408d-842d-9ed4971bdea9</RequesteeContactKey>
    <RequestorContactKey>0e4cbdd4-132f-4462-8a50-c9589f140b1a</RequestorContactKey>
  </Friend>
</ArrayOfFriend>