Call us toll-free @ 888-497-7898

API Call Information

area: email

action: getips

API Arguments

Argument Data Type Required Description
start integer No Starting position
limit integer No Number of records to return

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getips&start=0&limit=10

API Response

XML Response

<response>
<records>1</records>
<ip>
<id>1873</id>
<ipaddress>127.0.0.1</ipaddress>
<status>IP is ready</status>
<datecreated>September 26, 2011, 12:56:44 pm</datecreated>
<shareable>No</shareable>
<senderscore/>
<serverid>198</serverid>
<monitorenabled>0</monitorenabled>
<monitornexttime>Never</monitornexttime>
</ip>
</response>

JSON Response

{
    "records": "1",
    "ip": {
        "id": "1873",
        "ipaddress": "127.0.0.1",
        "status": "IP is ready",
        "datecreated": "September 26, 2011, 12:56:44 pm",
        "shareable": "No",
        "senderscore": "",
        "serverid": "198",
        "monitorenabled": "0",
        "monitornexttime": "Never"
    }
}