List unsubscribes

Request

Retrieve your unsubscribe list with filtering and search capabilities.

Use this to:

Monitor user opt-out trends
Export unsubscribe lists for compliance
Audit unsubscribe sources (API, link clicks, manual)
Filter by domain or view all unsubscribes
Track consent management across your domains

Complete unsubscribe lifecycle management with comprehensive analytics and compliance reporting.

Each unsubscribe includes a scope field indicating whether it's global (all domains) or domain-specific.

Note: For system-managed suppressions (bounces, complaints), see the /api/v1/customer/suppressions endpoints.

Security

ApiKeyAuth

Query

pageinteger, >= 1

Default:1

limitinteger, [ 1 .. 100 ]

Default:50

searchstring

Search by email address (partial match)

domain_idstring, (uuid)

Filter by specific domain (omit to see all unsubscribes)

from_datestring, (date)

Filter from date (YYYY-MM-DD)

to_datestring, (date)

Filter to date (YYYY-MM-DD)

curl -i -X GET \
  'https://api.mailerlogic.net/api/customer/unsubscribes?page=1&limit=50&search=string&domain_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&from_date=2019-08-24&to_date=2019-08-24' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Unsubscribes retrieved successfully

Bodyapplication/json

unsubscribesArray of objects(Unsubscribe)

paginationobject(Pagination)

Response

{
  "unsubscribes": [
    { … },
    { … }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 25,
    "pages": 1
  }
}