This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
api-mailinglists [2017/02/03 14:51] ben [Endpoint] |
api-mailinglists [2017/05/04 09:09] ben [Response] |
||
---|---|---|---|
Line 53: | Line 53: | ||
"Description": "For contacts who receive our standard offers emails." | "Description": "For contacts who receive our standard offers emails." | ||
} | } | ||
+ | ] | ||
+ | </code>| | ||
+ | |||
+ | |||
+ | ===== Get Mailing List Subscribers ===== | ||
+ | |||
+ | This Endpoint is used to get all the Contacts that are currently Subscribed to a particular Mailing List and are Emailable (those that are Unsubscribed or marked as having a Bad Email Address are excluded). | ||
+ | |||
+ | You can find the [[/mailing-lists|Mailing List]] External IDs on the [[/mailing-lists|Mailing List]] page in Sentori or by calling the Get All Mailing Lists API Endpoint. | ||
+ | |||
+ | ==== Endpoint ==== | ||
+ | |URI| <nowiki>https://api.sentoriapp.com/v2.0/mailinglists/subscribers/{MailingListExternalID}</nowiki>| | ||
+ | |Method| GET | | ||
+ | |||
+ | ==== Response ==== | ||
+ | |||
+ | |Field| Type|Description | | ||
+ | |SystemID|integer| The SystemID of a Contact.| | ||
+ | |EmailAddress|string| The email address of a Contact.| | ||
+ | |||
+ | |Example|<code javascript> | ||
+ | [ | ||
+ | { | ||
+ | "SystemID": "1", | ||
+ | "EmailAddress": "contact1@sentori.co.uk" | ||
+ | }, | ||
+ | { | ||
+ | "SystemID": "2", | ||
+ | "EmailAddress": "contact2@sentori.co.uk" | ||
+ | }, | ||
] | ] | ||
</code>| | </code>| |