Requesting Client Data

Use the get-by-address method to request client’s data for a specified EXT_USER_ID identifier.

EXT_USER_ID identifier is assigned at client’s creation. To update or remove a client, you need the client’s EXT_USER_ID identifier.

URL

To use the method, send a GET request to https://app.edna.io/api/subscribers/get-by-address.

Request parameters

ParameterTypeRequiredDescription
addressstringyesEXT_USER_ID value assigned to the client at creation.
typestringyesEXT_USER_ID

Request example

{
  "address": "id87552",
  "type": "EXT_USER_ID"
}

Response parameters

ParameterType Description
idnumberInternal client identifier in edna Pulse
blacklistedbooleanDetermines if the client receives broadcasts: true — the client is blacklisted, false — the client receives broadcasts
addressesobjectContains client addresses and identifiers
addresses.idstringAddress identifier
addresses.addressstringClient’s address, such as a phone number or id
addresses.typestringType of client address (EDNA_ID, PHONE, EMAIL, UTM, COOKIE_ID, INSTAGRAM_ID, FACEBOOK_ID, TELEGRAM_ID, GOOGLE_ID, APPLE_ID, YANDEX_ID, DEVICE_APP_ID, EXT_USER_ID)
addresses.infoobjectService info about the address
addresses.info.@type stringType of client identifier:
– PhoneInfo — phone number
– DeviceAppInfo — push-device identifier, DEVICE_APP_ID

These objects contain different sets of parameters. See reply example below.
parameterValuesobjectArray of parameters
parameterValues.namestringParameter name
parameterValues.valueTypestringParameter data type (STRING, ENUM, DATE, NUMBER, BOOLEAN)
parameterValues.valuestringParameter value
tagValuesobjectArray of tags
tagValues.namestringTag name

Reply sample

{
    "id": 63979781,
    "blacklisted": false,
    "addresses": [
        {
            "id": "2f1c95bd-897d-4dec-a45b-f13b0f16c558",
            "address": "10000000000",
            "type": "PHONE"
            "info": {
                "@type": "PhoneInfo",
                "phoneStatus": "VALID",
                "phonePrefix": "7900600",
                "operatorUnitRegion": {
                    "id": 135,
                    "operatorUnitId": 40,
                    "name": "New York",
                    "code": "usa-sprint_new_york",
                    "timeZone": "NA/Eastern_Time_Zone"
                }
            }
        },
        {
            "id": "9b2aff72-f34f-4319-ae4b-bcd854b8ac22",
            "address": "id87552"
            "type": "EXT_USER_ID"
        },
        {
            "id": "d70a07cf-6e29-492a-bedf-da2fe3800b71",
            "address": "gcmv9v9ewctw12ekdy6nbit2g82gfhit1w",
            "type": "DEVICE_APP_ID"
            "info": {
                "@type": "DeviceAppInfo",
                "deviceName": "android-build",
                "systemName": "Google Pixel 4a",
                "deviceUID": "6e083b67005411b28e736bbcda15d0a2b5d8bb08",
                "appPackageName": "com.edna.android.push.demo_x",
                "pushAppType": "ANDROID"
            }
        }
    ],
    "parameterValues": [],
    "tagValues": [
        {
            "name": "new_users"
        }
    ]
}

logout Method
Next Article Updating Client Data