/api/identity/v1/friends

Returns the friends of an Identity.

Request

GET /{tenant}/api/identity/v1/friends

GET /{tenant}/api/identity/v1/{id}/friends

Authentication

For more information on how to authenticate see How To: Call The Identity Hub API

Request Parameters

Name	Value	Description	Required
id	The identityId of the identity	Instructs The Identity Hub to return the friends of the identity matching the provided identityId. The caller must be authorized to access the identity.	No (defaults to authenticated identity)

Example Request

GET /{tenant}/api/identity/v1/12487978/friends
Authorization: Bearer puDWcq-4-xLwoG6y0DwZRA
Host: www.theidentityhub.com

Response

If the method call is successful returns the friends of the identity in JSON format.

Name	Value	Description
displayName	The displayname
identityId	The identity id	Can be used to call to get more information on the friend /api/identity/v1
largePictures	Array of URLs	Large profile pictures of the friend (if any)
mediumPictures	Array of URLs	Medium profile pictures of the friend (if any)
smallPictures	Array of URLs	Small profile pictures of the friend (if any)

Example Response

[
    {
        "displayName": "Jane Doe",
        "identityId": "14529564477878102528",
        "largePictures": [
            "https://graph.facebook.com/v2.1/706452a5645235/picture?type=large"
        ],
        "mediumPictures": [
            "https://graph.facebook.com/v2.1/706452a5645235/picture?type=normal"
        ],
        "smallPictures": [
            "https://graph.facebook.com/v2.1/706452a5645235/picture?type=small"
        ]
    }
    {
        "displayName": "John Doe",
        "identityId": "45971456423132123123123"        
    }
]