{"id":3650,"date":"2023-08-30T07:30:39","date_gmt":"2023-08-30T06:30:39","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3650"},"modified":"2024-06-25T12:48:09","modified_gmt":"2024-06-25T11:48:09","slug":"get-suppression-lists","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/suppression-lists\/get-suppression-lists\/","title":{"rendered":"Get suppression lists"},"content":{"rendered":"\n

Lists collection allows retrieving all active suppression 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

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/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\/SuppressionLists?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>
SuppressionLists<\/td>array[complex]<\/td>Array of SuppressionList elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
SuppressionList element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>Suppression list identifier.<\/td><\/tr>
Name<\/td>string<\/td>Suppression list name.<\/td><\/tr>
ListType<\/td>string<\/td>A suppression list type. Possible values:
Email
SmsMms<\/td><\/tr>
ImportRule<\/td>string<\/td>Import rule only for ‘Email’ list type. Possible values:
OnlyEmail
EmailAndDomain<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/SuppressionLists?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, 21 Feb 2018 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>SuppressionLists<\/span>><\/span><\/span>\n      <\/span><<\/span>SuppressionList<\/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>ListType<\/span>><\/span>Email<\/span><\/<\/span>ListType<\/span>><\/span><\/span>\n        <\/span><<\/span>ImportRule<\/span>><\/span>EmailAndDomain<\/span><\/<\/span>ImportRule<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SuppressionList<\/span>><\/span><\/span>\n      <\/span><<\/span>SuppressionList<\/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>ListType<\/span>><\/span>SmsMms<\/span><\/<\/span>ListType<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SuppressionList<\/span>><\/span><\/span>\n    <\/span><\/<\/span>SuppressionLists<\/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":3645,"menu_order":302,"template":"","format":"standard","emp-category":[],"class_list":["post-3650","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3650","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\/3650\/revisions"}],"predecessor-version":[{"id":11011,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3650\/revisions\/11011"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3645"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3650"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3650"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}