{"id":3658,"date":"2023-08-30T07:47:15","date_gmt":"2023-08-30T06:47:15","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3658"},"modified":"2024-07-10T10:24:19","modified_gmt":"2024-07-10T09:24:19","slug":"get-subscriber-lists","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/lists\/get-subscriber-lists\/","title":{"rendered":"Get subscriber lists"},"content":{"rendered":"\n

Lists collection allows retrieving of all subscriber lists defined in the system.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Parameters<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
seedLists<\/td>boolean<\/td>If set to ‘true’, only seed lists will be returned. If set to ‘false’, only regular lists will be returned. Optional. Default is false. <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/Lists?apiKey=YOUR_API_KEY_HERE<\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/Lists?apiKey=YOUR_API_KEY_HERE&seedLists=true<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Get list by List ID<\/strong><\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
ID<\/td>int<\/td>List ID. Required as a part of address (not GET parameter). See example below.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/Lists\/123?apiKey=YOUR_API_KEY_HERE<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Lists<\/td>array[complex]<\/td>Array of Lists elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Lists element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>List identifier.<\/td><\/tr>
Name<\/td>string<\/td>List name.<\/td><\/tr>
FriendlyName<\/td>string<\/td>List name used for display purposes.<\/td><\/tr>
Language<\/td>string<\/td>List language, e.g en-US.<\/td><\/tr>
OptInMode<\/td>string<\/td>List opt-in mode. One of:
– SingleOptIn
– DoubleOptIn<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Get list by List ID<\/strong><\/p>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Name<\/td>string<\/td>List name.<\/td><\/tr>
CreatedDate<\/td>datetime<\/td>List creation date<\/td><\/tr>
Language<\/td>string<\/td>List language, e.g en-US.<\/td><\/tr>
IsSeedList<\/td>bool<\/td>Is the seed list <\/td><\/tr>
IsDeleted<\/td>bool<\/td>Is the list deleted<\/td><\/tr>
OptInMode<\/td>string<\/td>List opt-in mode. One of:
– SingleOptIn
– DoubleOptIn<\/td><\/tr>
Size<\/td>int<\/td>List size<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Example<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/Lists?apiKey=test_api_key1 HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nConnection: Keep-Alive<\/span><\/span>\nUser-Agent: Apache-HttpClient\/4.1.1 (java 1.5)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 3.0<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Wed, 26 Jun 2013 13:35:54 GMT<\/span><\/span>\nContent-Length: 320<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>Lists<\/span>><\/span><\/span>\n      <\/span><<\/span>List<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>1<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>clients<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>FriendlyName<\/span>><\/span>My Clients<\/span><\/<\/span>FriendlyName<\/span>><\/span><\/span>\n        <\/span><<\/span>Language<\/span>><\/span>en-US<\/span><\/<\/span>Language<\/span>><\/span><\/span>\n        <\/span><<\/span>OptInMode<\/span>><\/span>DoubleOptIn<\/span><\/<\/span>OptInMode<\/span>><\/span><\/span>\n      <\/span><\/<\/span>List<\/span>><\/span><\/span>\n      <\/span><<\/span>List<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>2<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>friends<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>FriendlyName<\/span>><\/span>My Friends<\/span><\/<\/span>FriendlyName<\/span>><\/span><\/span>\n        <\/span><<\/span>Language<\/span>><\/span>pl-PL<\/span><\/<\/span>Language<\/span>><\/span><\/span>\n        <\/span><<\/span>OptInMode<\/span>><\/span>SingleOptIn<\/span><\/<\/span>OptInMode<\/span>><\/span><\/span>\n      <\/span><\/<\/span>List<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Lists<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Get list by List ID<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/Lists\/893?apiKey=test_api_key1 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nContent-Encoding: gzip <\/span><\/span>\nVary: Accept-Encoding <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=3e0htsjefgfcby55ra5b2045; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 1.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Mon, 24 May 2010 12:59:37 GMT <\/span><\/span>\nContent-Length: 369  <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n    <\/span><<\/span>Data<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>list_name <\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>CreatedDate<\/span>><\/span>2024-03-18T09:11:13.79<\/span><\/<\/span>CreatedDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Language<\/span>><\/span>en-US<\/span><\/<\/span>Language<\/span>><\/span><\/span>\n        <\/span><<\/span>IsSeedList<\/span>><\/span>false<\/span><\/<\/span>IsSeedList<\/span>><\/span><\/span>\n        <\/span><<\/span>IsDeleted<\/span>><\/span>false<\/span><\/<\/span>IsDeleted<\/span>><\/span><\/span>\n        <\/span><<\/span>OptInMode<\/span>><\/span>DoubleOptIn<\/span><\/<\/span>OptInMode<\/span>><\/span><\/span>\n        <\/span><<\/span>Size<\/span>><\/span>2015<\/span><\/<\/span>Size<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3656,"menu_order":298,"template":"","format":"standard","emp-category":[],"class_list":["post-3658","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3658","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3658\/revisions"}],"predecessor-version":[{"id":11149,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3658\/revisions\/11149"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3656"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3658"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3658"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}