Call us toll-free @ 888-497-7898

API Call Information

area: listverify

action: viewlist

API Arguments

Argument Data Type Required Description
id integer Yes list id of the verified list
start integer No Starting position
limit integer No Number of records to return
export boolean either 1 or 0 No exports the whole list to a csv file if this is set to 1

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=listverify&action=viewlist&id=5656&export=0

API Response

XML Response

<response>
<records>2</records>
<record>
<email>
<![CDATA[test@test.com]]>
</email>
<emaildomain>
<![CDATA[cardinalgl.com]]>
</emaildomain>
<status>
<![CDATA[Address does not exist]]>
</status>
<emailhash>
<![CDATA[52710273028]]>
</emailhash>
<debugreason>
<![CDATA[]]>
</debugreason>
<emailid>
<![CDATA[1]]>
</emailid>
</record>
<record>
<email>
<![CDATA[test@test.com]]>
</email>
<emaildomain>
<![CDATA[cbexchange.com]]>
</emaildomain>
<status>
<![CDATA[Valid Record]]>
</status>
<emailhash>
<![CDATA[427922067527]]>
</emailhash>
<debugreason>
<![CDATA[]]>
</debugreason>
<emailid>
<![CDATA[2]]>
</emailid>
</record>
</response>

JSON Response

{
    "records": "2",
    "record": [
        {
            "email": "test@test.com",
            "emaildomain": "cardinalgl.com",
            "status": "Address does not exist",
            "emailhash": "52710273028",
            "debugreason": "",
            "emailid": "1"
        },
        {
            "email": "test@test.com",
            "emaildomain": "cbexchange.com",
            "status": "Valid Record",
            "emailhash": "427922067527",
            "debugreason": "",
            "emailid": "2"
        }
    ]
}