Retrieving list unsubscribers via the lists V2 api

Question

We are implementing an integration in a web app with Klaviyo to, amongst other things, synch unsubscribers between Klaviyo and our web app. As part of this we need to retrieve all unsubscribers from Klaviyo to update our web app.

To retrieve the unsubscribers from Klaviyo we’ve been looking to make a call to the GET https://a.klaviyo.com/api/v2/list/{LIST_ID}/exclusions/all end point but I am not seeing any of the unsubscribed profiles being returned. The profile was unsubscribed via the DELETE https://a.klaviyo.com/api/v2/list/{LIST_ID}/subscribe end point.

The profile history does show that it has been unsubscribed from the list but the profile does not show in the list of exclusions in Lists & Segments so I suspect the exclusions end point is the wrong one to use. What would be the correct api end point to use to retrieve a list of all unsubscribers?

Any help would be appreciated, thanks.

icon

Best answer by caroline 17 December 2020, 04:28

View original

caroline · Accepted Answer

Hi there,The DELETE /api/v2/list/{LIST_ID}/members endpoint will unsubscribe a profile from a list, while the DELETE /api/v2/list/{LIST_ID}/subscribe endpoint will add the profile as a single-list suppression and remove the profile from the list.Most Klaviyo accounts are configured to treat single-list suppressions as global suppressions. You can read more about this here.As a result, if you unsubscribed a profile using the DELETE /api/v2/list/{LIST_ID}/subscribe endpoint, the profile would be treated as a global suppression. The GET exclusions/all endpoint does not return global suppressions (it returns list-specific suppressions).You can use the GET api/v1/people/exclusions endpoint to retrieve global suppressions instead.Hope this helps!Best,Caroline

k.mcevoy · Answer

Hi there,Thanks for reaching out to the Community! TheGEThttps://a.klaviyo.com/api/v2/list/{LIST_ID}/exclusions/allend point will show all profiles that have been unsubscribed from a specific list. If the profile was not unsubscribed from the list specified in the GET request we will not pull the profile.To get a list of all unsubscribed profiles in your account I would create a segment with the following criteria:And then use the following endpoint to retrieve the profiles on the Unsubscribed list you create:GET https://a.klaviyo.com/api/v2/list/{LIST_ID}/members

Retrieving list unsubscribers via the lists V2 api

4 replies

Reply

Most helpful members this week

Reply

Most helpful members this week

Sign up

Use your Klaviyo credentials

Log in to the Community

Use your Klaviyo credentials

Scanning file for viruses.

This file cannot be downloaded