HomeAppVirality DocsAppVirality APIsGet User Details

Get User Details

Allows you to extract all details of a user in your App, as captured & maintained by AppVirality

This API call allows you to obtain some critical info points regarding an app user. Things like user’s email, advertising ID, username, referrer code, etc. could be warranted at various points inside the app during a user’s active experience. This API offers you just that.

Base URL  https://api.appvirality.com

 POST         /v2_0/getuserdetails

Content-Type application/json

Input i.e. Request

"UserIdInstore": ""
Input Params
Input Params Description
apikey API Key of the App
Get it from Dashboard >> App Details
User Key for the an 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
privatekey Private key for API requests
Get it from: Dashboard >> App Details >> Click App Settings >> Scroll down to Advanced Settings

conditional – One of the conditional parameters is mandatory to identify the user. Priority for user identification is userkey, UserIdInstore and EmailId


    "users": [
            "userkey": "c559d71da012426694580e3f3ddd6548",
            "deviceid": "466777753211",
            "primaryemail": "testcam@stag.growthscore.io",
            "advertisingid": null,
            "name": null,
            "profileimage": null,
            "city": null,
            "state": null,
            "country": null,
            "hardwareid": "359299052767956",
            "phonenumber": null,
            "pushdevicetoken": null,
            "installedipaddress": "",
            "referralcode": "momg29m",
            "userstoreid": null,
            "platform": "Android",
            "otheremails": [
                    "emailid": "testcam@stag.growthscore.io",
                    "updateddate": "22-May-2018 23:36:27"
    "success": true,
    "statuscode": 1,
    "message": "Success"
Response Params
Output Params Description
userkey User Key for the an App user, assigned by AppVirality – a unique identifier for every App User recorded
deviceid Unique ID assigned to a device
primaryemail Email of the User
advertisingid Advertising ID assigned to Device by Google/Apple
name Name of the User
profileimage User profile picture URL
city City of the User Location
state State of the User Location
country Country of the User Location
hardwareid Device IMEI
phonenumber User phone number
pushdevicetoken Unique id assigned to the device by your Push Notification Service
installedipaddress Installed IP Address
referralcode User's Referral Code
userstoreid ID of the user in your App
(helps to identify users on dashboard as you do in your app)
otheremails User's Emails
success Call Success Response (true/false)
status code code based on status of the API call
message Information regarding API call (if relevant)

Status codes which you will see while using Get App User Details 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