Get User (Visitor) Attributes By User ID API

GET /v2/users/{user_id}

Description:

This API returns a single visitor (referred to as a user) along with its attributes.

API Limit:

600 requests per minute. Client receives 429 once over the limit.

Method Details:

HTTP method: GET

Response format: JSON

Headers:

useriq-api-key: Your valid API key generated from the site settings page

Content-Type: application/json

Parameters:

Path Parameters:

• user_id: required, the user id used to fetch the visitor. It is the value the client sends through the tracking code.

Response:

Status code 200:

The body contains

• result: a visitor account along with its mapped attributes.

• success: true or false.

Other Status codes:

400: Bad request

401: Unauthorized

429: Too many requests

500: Internal Server Error

GET v2/users/[email protected]

{

 "success": true,

 "result": {

    "user_name": "Mudit@QA",

    "user_first_name": "Mudit",

    "user_last_name": "Jackson",

    "user_id": "[email protected]",

    "account_id": "123456191",

    "email": "[email protected]",

    "created_at": "2021-04-19 10:08:52.478",

 "attributes": [

    {

       "name": "Phone (Office)",

        "source": "hubspot",

        "source_variable": "phone",

        "value": "678-510-1124",

        "data_type": "string",

        "created_at": "2020-12-02 16:28:46.218",

        "updated_at": "2020-12-15 22:31:17.123"

    },

    {

        "name": "Email Address",

        "source": "hubspot",

        "source_variable": "user_email",

        "value": "[email protected]",

        "data_type": "string",

        "created_at": "2021-03-02 19:29:38.158",

        "updated_at": "2021-04-12 16:50:56.663"

   },

   {

       "name": "Phone (Home)",

        "source": "sfdc",

        "source_variable": "home_phone",

        "value": "(678) 510-6222",

        "data_type": "string",

        "created_at": "2021-03-02 19:29:38.39",

        "updated_at": "2021-04-27 20:40:54.923"

  },

  {

       "name": "Phone (Mobile)",

        "source": "sfdc",

        "source_variable": "mobile_phone",

        "value": "(678) 510-6223",

        "data_type": "string",

        "created_at": "2021-03-02 19:29:38.599",

        "updated_at": "2021-04-27 20:40:55.104"

  } 

 ]

}

}