# List unsubscribes

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.

Endpoint: GET /api/customer/unsubscribes
Version: 1.0.0
Security: ApiKeyAuth

## Query parameters:

  - `page` (integer)

  - `limit` (integer)

  - `search` (string)
    Search by email address (partial match)

  - `domain_id` (string)
    Filter by specific domain (omit to see all unsubscribes)

  - `from_date` (string)
    Filter from date (YYYY-MM-DD)

  - `to_date` (string)
    Filter to date (YYYY-MM-DD)

## Response 200 fields (application/json):

  - `unsubscribes` (array)

  - `unsubscribes.id` (string)
    Unique unsubscribe record ID

  - `unsubscribes.email` (string)
    Unsubscribed email address

  - `unsubscribes.source` (string)
    How the unsubscribe occurred
    Enum: "link", "one-click", "api", "manual"

  - `unsubscribes.reason` (string)
    Reason for unsubscribe

  - `unsubscribes.created_at` (string)
    When the unsubscribe occurred

  - `pagination` (object)

  - `pagination.page` (integer)

  - `pagination.limit` (integer)

  - `pagination.total` (integer)
    Total number of items

  - `pagination.pages` (integer)
    Total number of pages

## Response 401 fields (application/json):

  - `error` (string)
    Error code or message

## Response 500 fields (application/json):

  - `error` (string)
    Error code or message