Embedded Files
API Documentation V2
Lists collection allows retrieving of all subscriber lists defined in the system.
Request data format
Request data format
Request URL parameters:
Examples:
https://api.esv2.com/v2/Api/Lists?apiKey=YOUR_API_KEY_HERE
https://api.esv2.com/v2/Api/Lists?apiKey=YOUR_API_KEY_HERE&seedLists=true
Response
Response
Response Data element:
Lists element children:
Example
Example
Request:
GET
https://api.esv2.com/v2/Api/Lists?apiKey=test_api_key1 HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
OK response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 3.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 26 Jun 2013 13:35:54 GMT
Content-Length: 320
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Data>
<Lists>
<List>
<Id>1</Id>
<Name>clients</Name>
<FriendlyName>My Clients</FriendlyName>
<Language>en-US</Language>
<OptInMode>DoubleOptIn</OptInMode>
</List>
<List>
<Id>2</Id>
<Name>friends</Name>
<FriendlyName>My Friends</FriendlyName>
<Language>ru-RU</Language>
<OptInMode>SingleOptIn</OptInMode>
</List>
</Lists>
</Data>
</ApiResponse>
Report abuse