Skip to main content

Get profile data

Description​

Retrieves customer profile data, including database fields and subscriptions.

Request URL​

Method: POST

https://example.com/api/v1.1/profiles/get/

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
db_idint1YesDatabase ID
Profile matching mode
matchingstring"email"
"email_profile"
"email_sub"
"phone"
"phone_sub"
"profile_id"
"push_sub"
"custom"
"custom_sub"
"email_phone"
"email_phone_sub"		No, if matched by emailProfile matching mode
By default - email
emailstring"example@example.com""matching":"email"Email address
phonestring"+79000000000""matching":"phone"Phone number
profile_idstring"abcdefghijklmnqrstuvwxyz""matching":"profile_id"Profile ID
field_namestring"CRM_ID""matching":"custom"Custom profile data field name
field_valueint/string"123420""matching":"custom"

Custom profile data field value.

tip

Searching by combination of tags is available for tag type profile fields. Values are recorded as a string: "tag-1, tag-2".

resource_idint24NoResource ID for email and phone matching

Request example​

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "db_id": 1,
    "email": "example@example.com"
}

Response example​

{
    "data": {
        "LOYALTY_SCORE": 500,
        "New_field_7": "00016",
        "_acid": "FBFLR5Z8BxgvNPxBJZgL",
        "_bdate": "1990-07-06T11:15:25.526Z",
        "_browser": "Chrome",
        "_city": "Beijing",
        "_click_exist": false,
        "_click_push_exist": false,
        "_click_sms_exist": false,
        "_confirm_exist": false,
        "_country": "CN",
        "_createtime": "2024-04-08T10:48:05.418Z",
        "_deliv_date": "2024-04-18T10:18:29.809Z",
        "_deliv_exist": true,
        "_deliv_push_exist": false,
        "_deliv_sms_date": "2024-05-06T10:00:05.548Z",
        "_deliv_sms_exist": true,
        "_domaingroup": "other",
        "_emaildomain": "example.com",
        "_fname": "Christopher",
        "_ip": "106.12.21.70",
        "_is_desktop": true,
        "_is_test": true,
        "_lat": 34.7732,
        "_lname": "Lambert",
        "_lon": 113.722,
        "_md5": "1118e73b34d3f9a9030b9e4da6dcfb29",
        "_open_date": "2024-04-18T10:18:29.727Z",
        "_open_exist": true,
        "_open_push_exist": false,
        "_os": "Windows 10",
        "_pixel_open_exist": false,
        "_platform": "Other",
        "_postal_code": "17",
        "_ps_wf": [
            12,
            11,
            10
        ],
        "_ps_wfs": [
            {
                "di": "2024-04-08T10:48:07.093Z",
                "do": "2024-04-13T10:48:22.359Z",
                "et": "",
                "ln": 8,
                "s": 1,
                "wId": 12
            },
            {
                "di": "2024-04-08T19:35:04.15Z",
                "do": "2024-04-12T19:37:19.821Z",
                "et": "",
                "ln": 8,
                "s": 1,
                "wId": 11
            },
            {
                "di": "2024-04-16T14:42:49.063Z",
                "do": "2024-04-17T14:42:52.438Z",
                "et": "",
                "ln": 8,
                "s": 1,
                "wId": 10
            }
        ],
        "_read_date": "2024-04-18T10:18:29.727Z",
        "_read_exist": true,
        "_regdate": "2024-04-08T10:48:05.418Z",
        "_region": "Beijing",
        "_reply_exist": false,
        "_send_date": "2024-04-10T09:32:06.275960407Z",
        "_send_exist": true,
        "_send_push_exist": false,
        "_send_sms_date": "2024-04-12T12:17:05.995339508Z",
        "_send_sms_exist": true,
        "_sex": 1,
        "_status": 0,
        "_subscribetime": "2024-04-08T10:48:05.418Z",
        "_tz": "Asia/Shanghai",
        "_undeliv_date": "2024-04-17T11:49:42.098Z",
        "_undeliv_exist": true,
        "_updatetime": "2024-04-19T14:25:22.185Z",
        "_xxh": "5ce324d8407a8e2b",
        "_xxm": 8507,
        "db_id": 1,
        "email": "example@example.com",
        "id": "6613cb65dc4594c2934db63f",
        "phones": [
            "+79568150396"
        ],
        "subscriptions": [
            {
                "resource_id": 24,
                "channel": "email",
                "email_data": {
                    "email": "example@example.com",
                    "domain": "example.com",
                    "domain_group": "other",
                    "md5": "1118e73b34d3f9a9030b9e4da6dcfb29"
                },
                "priority": 0,
                "status": "unsubscribed",
                "reg_info": {
                    "date": "2024-04-10T09:28:55.743Z"
                },
                "hash_id": "4a3c5813",
                "is_delete": false
            },
            {
                "resource_id": 25,
                "channel": "sms",
                "phone_data": {
                    "phone": "+79568150396",
                    "md5": "06ec7f059dae6f002d06a2f62a4320d8"
                },
                "priority": 0,
                "status": "subscribed",
                "reg_info": {
                    "date": "2024-04-12T12:16:44.086Z"
                },
                "hash_id": "f67a97c1",
                "is_delete": false
            }
        ],
        "unsub": {
            "c": 115,
            "dt": "2024-04-18T10:18:29.727Z",
            "m": 15
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

Response parameters​

ParameterTypeDescription
dataJSON objectProfile data
errorintError code
error_textstringError text
Last updated on