Call us toll free @ 888-497-7898

email - getlists

Returns a list of email lists found in the account

API Call Information
area: email
action: getlists

API Arguments

Argument	Data Type	Required	Description
start	integer	No	Starting position
limit	integer	No	Number of records to return
parent	integer	No	specify the folder integer is a the id of the folder.
id	string	No	list id or comma separated ids 1,2,3,4

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

API Result:

XML Response

JSON Response

<response>
  <records>5</records>
  <list>
    <id>504087</id>
    <title><![CDATA[UNiforms  Direct   complete cvs]]></title>
    <status/>
    <total>868</total>
    <active>808</active>
    <datecreated>May 10, 2024, 01:34 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>398kB</filesize>
    <liststatsurl><![CDATA[]]></liststatsurl>
  </list>
  <list>
    <id>504082</id>
    <title><![CDATA[uniforms distributor  Direct source]]></title>
    <status/>
    <total>226</total>
    <active>218</active>
    <datecreated>May 10, 2024, 11:32 am</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>1</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>112kB</filesize>
    <liststatsurl><![CDATA[]]></liststatsurl>
  </list>
  <list>
    <id>503893</id>
    <title><![CDATA[immigration attorney]]></title>
    <status/>
    <total>1034</total>
    <active>1002</active>
    <datecreated>May 01, 2024, 07:43 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>410kB</filesize>
    <liststatsurl><![CDATA[]]></liststatsurl>
  </list>
  <list>
    <id>502669</id>
    <title><![CDATA[uniforms]]></title>
    <status/>
    <total>2700</total>
    <active>2497</active>
    <datecreated>March 11, 2024, 03:41 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>843kB</filesize>
    <liststatsurl><![CDATA[]]></liststatsurl>
  </list>
  <list>
    <id>502629</id>
    <title><![CDATA[Uniforms 2]]></title>
    <status/>
    <total>150</total>
    <active>143</active>
    <datecreated>March 08, 2024, 04:51 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>91kB</filesize>
    <liststatsurl><![CDATA[]]></liststatsurl>
  </list>
</response>

{
    "records": "5",
    "list": [
        {
            "id": "504087",
            "title": "UNiforms  Direct   complete cvs",
            "status": "",
            "total": "868",
            "active": "808",
            "datecreated": "May 10, 2024, 01:34 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "398kB",
            "liststatsurl": ""
        },
        {
            "id": "504082",
            "title": "uniforms distributor  Direct source",
            "status": "",
            "total": "226",
            "active": "218",
            "datecreated": "May 10, 2024, 11:32 am",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "1",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "112kB",
            "liststatsurl": ""
        },
        {
            "id": "503893",
            "title": "immigration attorney",
            "status": "",
            "total": "1034",
            "active": "1002",
            "datecreated": "May 01, 2024, 07:43 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "410kB",
            "liststatsurl": ""
        },
        {
            "id": "502669",
            "title": "uniforms",
            "status": "",
            "total": "2700",
            "active": "2497",
            "datecreated": "March 11, 2024, 03:41 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "843kB",
            "liststatsurl": ""
        },
        {
            "id": "502629",
            "title": "Uniforms 2",
            "status": "",
            "total": "150",
            "active": "143",
            "datecreated": "March 08, 2024, 04:51 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "91kB",
            "liststatsurl": ""
        }
    ]
}