Get Global Exclusions & Unsubscribes

GET {{baseUrl}}/v1/people/exclusions?reason=&sort=asc&count=500&page=0

Returns global exclusions/unsubscribes. Global exclusions are distinct from list exclusions in that these email addresses will not receive any emails from any list. Typically, when someone unsubscribes from a campaign, they are only unsubscribed from that list and are not globally unsubscribed.

Request Params

KeyDatatypeRequiredDescription
reasonnullFilter results based on the reason for someone being excluded. The possible values are unsubscribed, bounced, invalid_email, reported_spam and manually_excluded. Only a single value may be specified at a time. Defaults to return all profiles regardless of reason.
sortstringSort order to apply to results, either ascending or descending. Valid values are asc or desc. Defaults to asc.
countnumberFor pagination, the number of results to return. Default = 500
pagenumberFor pagination, which page of results to return. Default = 0

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"object":"$list","data":[{"object":"exclusion","email":"george.washington@klaviyo.com","reason":"unsubscribed","timestamp":"2021-11-26 08:48:51"}],"page":0,"start":0,"end":0,"total":100,"page_size":1}