List unsubscribed contacts

Retrieves a paginated list of all contacts who have unsubscribed from a specific program's Outreach communications (Workflows, Newsletters, and Bulk Mail).

Parameters

---

PartnerID optional

Filter by partner.

---

UserEmail optional

Filter by specific email.

---

Page optional

The page number to retrieve. Starts at 0.

---

PageSize optional

The number of items per page. The maximum is 1000.

Returns

---

Returns a paginated list of unsubscribed contacts. Returns an error if an invalid or deleted program identifier is provided.

Example request

---

cURL

curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/<CampaignId>/UnsubscribedContacts' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'PartnerId=1234' \
  -d '[email protected]' \
  -d 'Page=0' \
  -d 'PageSize=20' \
  -G

Example response

---

JSON

{
    "Page": "0",
    "NumPages": "1",
    "PageSize": "20",
    "Total": "1",
    "Start": "0",
    "End": "1",
    "Uri": "/UnsubscribedContacts?page=0&size=20",
    "FirstPageUri": "/UnsubscribedContacts?page=0&size=20",
    "PreviousPageUri": "",
    "NextPageUri": "",
    "LastPageUri": "/UnsubscribedContacts?page=0&size=20",
    "Results": [
        {
            "UserEmail": "[email protected]",
            "PartnerId": "1234",
            "CreatedAt": "2026-02-05T12:13:08Z",
            "UpdatedAt": "2026-02-05T12:13:08Z"
        }
    ]
}