# suppressions.list

List email suppressions.

Lists deployment-global suppressions for system callers. With accountId, lists that account's complaints; account callers may select only their own account.

```ts
openemail.suppressions.list(
  options?: SuppressionsListOptions,
): PagePromise<SuppressionList, Suppression>
```

It calls `GET /suppressions`: [List email suppressions](/docs/api/suppressions/get_SuppressionListEndpoint) in the API reference.

## Example

```ts
for await (const suppression of openemail.suppressions.list()) {
  // every item of every page (await the call instead for one page)
}
```

## Options

The last argument, `options`, a `SuppressionsListOptions`, takes:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `limit` | `number` | query `limit` | Page size (default 100) |
| `cursor` | `string` | query `cursor` | Opaque page cursor from a previous response |
| `accountId` | `string` | query `accountId` | Sending account whose complaint suppressions to inspect or modify |

Every call also takes `signal`, `timeout`, `retry` and `headers`, which say how that one call is sent ([call options](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

It is a listing, a [`PagePromise`](/docs/sdks/typescript/listings). Awaited, it is one page as the API answers it, [`SuppressionList`](/docs/sdks/typescript/types/suppression-list). Iterated with `for await`, it is every [`Suppression`](/docs/sdks/typescript/types/suppression) of every page, each page fetched as the loop reaches it.

## Errors

| Status | What it means |
| --- | --- |
| `400` | validation_failed |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `403` | insufficient_scope — mailbox credentials or a foreign account; system_credentials_required — the global listing requires system credentials |
| `503` | suppression_moving: the address's bucket is being moved; retry after the Retry-After delay. Or temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

It names these types of the API, each on a page of its own: [`Suppression`](/docs/sdks/typescript/types/suppression), [`SuppressionList`](/docs/sdks/typescript/types/suppression-list).
