HomeAppVirality DocsAppVirality APIsGet Friend List

Get Friend List

This API call shall deliver you the list of Friends that a user onboarded via Referrals

Alike to the User rewards feature we talked about previously, this API call also enables a very fulfilling feature set for the Referrals.

The API call helps you get the entire list of friends, a particular user of your app has influenced into coming onto the app. You can define the list while requesting itself, to deliver … say.. 30 per page only.

Base URL  https://api.appvirality.com

 POST         /v2_0/getfriendslist

Content-Type application/json

Input i.e. Request

"EmailId": "",
"UserIdInstore": "",
Input Params
Input Params Description
apikey API Key of the App 
Get it from Dashboard >> App Details
privatekey Private key for API requests 
Get it from: Dashboard >> App Details >> Click App Settings >> Scroll down to Advanced Settings
User Key of the App user, assigned by AppVirality – a unique identifier for every App User recorded
Email of the User, updated to AppVirality
Store Id of the App user, updated to AppVirality – a unique identifier of the user in your App
conditional – One of the conditional parameters is mandatory to identify the user. Priority for user identification is userkey, UserIdInstore and EmailId


Parameters requiring explanation have been marked off with explanation employing code comments
The rest are self-explanatory

  "friends": [              // begin of FRIEND list for queried userkey
      "emailId": "test209234@gmail.com",
      "UserIdInstore": "t21esd",
      "name": "madhumanne",
      "profileImage": "",
      "regDate": "11-Jul-2015"  // date of sign-up
  "success": true,            // succes statement for API call
  "statuscode": 1,            // code based on status of the API call
  "message": success          // Information regarding API call (if relevant)

Status codes which you will see while using Get Friend List API

Status codes and description for API responses
Status Code Description
0 No data found for the search criteria
1 Success
2 Invalid User Key
5 Invalid StoreID or EmailID
Was this article helpful to you? Yes No 1