Call us toll-free @ 888-497-7898

API Call Information

area: email

action: getlistdetail

API Arguments

Argument Data Type Required Description
id integer Yes list id number
start integer No Starting position
limit integer No Number of records to return
filter string No allows the following values suppressed,active,softbounces,inactive,openers,clickers,openersorclickers,optout
emailid integer No filter to just the emailid of the email addresses
email string No filter to exact email address.

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getlistdetail&id=11234

API Response

XML Response

<response>
<records>1</records>
<email>test@test.com</email>
<emaildomain>test.com</emaildomain>
<status>Good</status>
<emailhash>206870899630</emailhash>
<clickts/>
<viewts/>
<clickip/>
<viewip/>
<emailid>1</emailid>
<debugreason/>
</response>

JSON Response

{
    "records": "1",
    "email": "test@test.com",
    "emaildomain": "test.com",
    "status": "Good",
    "emailhash": "206870899630",
    "clickts": "",
    "viewts": "",
    "clickip": "",
    "viewip": "",
    "emailid": "1",
    "debugreason": ""
}