Call us toll free @ 888-497-7898

leads - viewlead

Views a complete lead with custom fields and notes given the lead id passed as the id column

API Call Information
area: leads
action: viewlead

API Arguments

Argument	Data Type	Required	Description
id	integer	Yes	integer containing the lead id

API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=leads&action=viewlead&id=123456

API Result:

XML Response

JSON Response

<response>
<lead>
<id>126024</id>
<folderid>0</folderid>
<datecreated>April 17, 2014, 04:37:44 pm</datecreated>
<datelastupdated>April 17, 2014, 04:37:44 pm</datelastupdated>
<datefollowup/>
<status>0</status>
<priority>0</priority>
<company>TEST</company>
<firstname>John</firstname>
<lastname>Smith</lastname>
<jobtitle>owner</jobtitle>
<email>test@test.com</email>
<phone>1234567890</phone>
<address>123 Main Street</address>
<city>Sometown</city>
<region>IL</region>
<zip>60532</zip>
<country>US</country>
<badphone>0</badphone>
<bademail>0</bademail>
<altemail>test@test.com</altemail><altphone>123456345675437</altphone>
<ip/><websiteurl/>
<labelid>65</labelid>
<label>Test</label>

<customfields><field><title>Condition</title><data>new</data></field>
</customfields>

<notes><note><id>66846</id><firstname/><lastname/><datecreated>April 17, 2014, 04:37:44 pm</datecreated><notebody>Email Sent to: test@test.com <br/>
Subject: Testing VR Lead</notebody></note><note><id>66845</id><firstname/><lastname/><datecreated>April 17, 2014, 04:36:02 pm</datecreated><notebody>Email Sent to: test@test.com <br/>
Subject: test auto followup email.</notebody></note><note><id>50186</id><firstname>MM</firstname><lastname>Corp</lastname><datecreated>September 17, 2013, 09:01:17 am</datecreated><notebody>test</notebody></note></notes>
</lead>
</response>

{
    "lead": {
        "id": "126024",
        "folderid": "0",
        "datecreated": "April 17, 2014, 04:37:44 pm",
        "datelastupdated": "April 17, 2014, 04:37:44 pm",
        "datefollowup": "",
        "status": "0",
        "priority": "0",
        "company": "TEST",
        "firstname": "John",
        "lastname": "Smith",
        "jobtitle": "owner",
        "email": "test@test.com",
        "phone": "1234567890",
        "address": "123 Main Street",
        "city": "Sometown",
        "region": "IL",
        "zip": "60532",
        "country": "US",
        "badphone": "0",
        "bademail": "0",
        "altemail": "test@test.com",
        "altphone": "123456345675437",
        "ip": "",
        "websiteurl": "",
        "labelid": "65",
        "label": "Test",
        "customfields": {
            "field": {
                "title": "Condition",
                "data": "new"
            }
        },
        "notes": {
            "note": [
                {
                    "id": "66846",
                    "firstname": "",
                    "lastname": "",
                    "datecreated": "April 17, 2014, 04:37:44 pm",
                    "notebody": "Email Sent to: test@test.com Subject: Testing VR Lead"
                },
                {
                    "id": "66845",
                    "firstname": "",
                    "lastname": "",
                    "datecreated": "April 17, 2014, 04:36:02 pm",
                    "notebody": "Email Sent to: test@test.com Subject: test auto followup email."
                },
                {
                    "id": "50186",
                    "firstname": "MM",
                    "lastname": "Corp",
                    "datecreated": "September 17, 2013, 09:01:17 am",
                    "notebody": "test"
                }
            ]
        }
    }
}