Call us toll free @ 888-497-7898

leads - getleadslist

Gets a list of leads from the account.
To view more detail on the lead itself take the lead id and use the viewlead api

API Call Information
area: leads
action: getleadslist

API Arguments

Argument	Data Type	Required	Description
start	integer	No	Starting position for records
limit	integer	No	Number of records to return
parent	integer	No	is the folderid if you are using subfolders to store leads

API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=leads&action=getleadslist&start=0&limit=10

API Result:

XML Response

JSON Response

<response>
<records>2</records>
<lead>
<id>126024</id>
<isfolder>0</isfolder>
<title>TEST</title>
<firstname>John</firstname>
<lastname>Smith</lastname>
<email>test@test.com</email>
<phone>1234567890</phone>
<status>Open</status>
<priority>None</priority>
<datefollowup/>
<datelastupdated>April 17, 2014, 04:37:44 pm</datelastupdated>
<touches>4</touches>
<totalnotes>0</totalnotes>
</lead>
<lead>
<id>126023</id>
<isfolder>0</isfolder>
<title>TEST</title>
<firstname/>
<lastname/>
<email>test@test.com</email>
<phone/>
<status>Open</status>
<priority>None</priority>
<datefollowup/>
<datelastupdated>September 17, 2013, 09:00:26 am</datelastupdated>
<touches>4</touches>
<totalnotes>0</totalnotes>
</lead>
</response>

{
    "records": "2",
    "lead": [
        {
            "id": "126024",
            "isfolder": "0",
            "title": "TEST",
            "firstname": "John",
            "lastname": "Smith",
            "email": "test@test.com",
            "phone": "1234567890",
            "status": "Open",
            "priority": "None",
            "datefollowup": "",
            "datelastupdated": "April 17, 2014, 04:37:44 pm",
            "touches": "4",
            "totalnotes": "0"
        },
        {
            "id": "126023",
            "isfolder": "0",
            "title": "TEST",
            "firstname": "",
            "lastname": "",
            "email": "test@test.com",
            "phone": "",
            "status": "Open",
            "priority": "None",
            "datefollowup": "",
            "datelastupdated": "September 17, 2013, 09:00:26 am",
            "touches": "4",
            "totalnotes": "0"
        }
    ]
}