---
title: "Return a list of suppressed emails (hard, soft, complaint)."
method: GET
path: "/Ams/{ClientID}/EmailSuppressionList"
tags: ["Ams"]
---

# Return a list of suppressed emails (hard, soft, complaint).

`GET /Ams/{ClientID}/EmailSuppressionList`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/{ClientID}/EmailSuppressionList`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/:ClientID/EmailSuppressionList/get.ts> (a function with typed inputs; its response is checked against the schema)

Return a list of suppressed emails (hard, soft, complaint).

## Path parameters

- `ClientID` integer, required

## Query parameters

- `EmailSuppressionFilter` 'Hard' | 'Soft' | 'Hard_Soft' | 'Complaint' | 'Hard_Complaint' | 'Soft_Complaint' | 'Hard_Soft_Complaint'
- `PageSize` integer
- `PageNumber` integer
- `OffSet` integer
- `OrderBy` string
- `OrderByDirection` string
- `EmailSearchString` string
- `MemberID` integer
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- EmailSuppressionListResponse: EmailSuppressionListResponse
  - `SuppressionList` EmailSuppression[]
    - `EmailAddress` string
    - `SuppressionType` string
    - `IsActive` boolean
    - `BounceCount` integer
    - `SuppressCount` integer
    - `SuppressedDate` string, date-time
    - `LastRemoved` string, date-time
    - `OriginalBounceDate` string, date-time
    - `EstimatedRemovalDate` string, date-time
    - `Status` string
    - `BounceReason` string
    - `FeedbackType_Group` string
    - `FeedbackType_Type` string
    - `FeedbackType_SubType` string
  - `TotalResultsCount` integer
  - `HardBounceHealthRate` number, double
  - `SoftBounceHealthRate` number, double
  - `ComplaintHealthRate` number, double
  - `EmailSuppressionFilter` 'Hard' | 'Soft' | 'Hard_Soft' | 'Complaint' | 'Hard_Complaint' | 'Soft_Complaint' | 'Hard_Soft_Complaint'
  - `PageSize` integer
  - `PageNumber` integer
  - `OffSet` integer
  - `OrderBy` string
  - `OrderByDirection` string
  - `EmailSearchString` string
  - `MemberID` integer
  - `ClientID` integer
  - `ResponseStatus` ResponseStatus: ResponseStatus
    - `ErrorCode` string
    - `Message` string
    - `StackTrace` string
    - `Errors` ResponseError[]
      - `ErrorCode` string
      - `FieldName` string
      - `Message` string
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `Meta` DictionaryStringString: Dictionary<String,String>
  - `BypassCache` boolean
  - `DateCached` string, date-time
  - `Device` string

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)
