> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Resend: Suppressions List

> Retrieve a list of suppressions. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve a list of suppressions.

> [!NOTE]
>
> Tool ID: `resend_suppressions_list`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'resend_suppressions_list',
  {
    "origin": "bounce",
    "limit": 100,
    "after": "cursor_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run resend_suppressions_list --input '{
  "origin": "bounce",
  "limit": 100,
  "after": "cursor_123"
}'
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "example",
    "has_more": true,
    "data": [
      {
        "id": "id_123",
        "email": "jane.doe@example.com",
        "origin": "bounce"
      }
    ]
  }
}
```

Use `deepline describe resend_suppressions_list --json` for the latest machine-readable contract.

## Input reference

Retrieve a list of suppressions

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.origin` | `"bounce" \| "complaint" \| "manual"` | No | — | Filter suppressions by origin. Allowed: `bounce`, `complaint`, `manual`. |
| `payload.limit` | `integer` | No | — | Number of items to return. Minimum: 1. Maximum: 100. |
| `payload.after` | `string` | No | — | Return items after this cursor. |
| `payload.before` | `string` | No | — | Return items before this cursor. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve a list of suppressions",
    "properties": {
      "origin": {
        "type": "string",
        "description": "Filter suppressions by origin.",
        "enum": [
          "bounce",
          "complaint",
          "manual"
        ]
      },
      "limit": {
        "type": "integer",
        "description": "Number of items to return.",
        "minimum": 1,
        "maximum": 100
      },
      "after": {
        "type": "string",
        "description": "Return items after this cursor."
      },
      "before": {
        "type": "string",
        "description": "Return items before this cursor."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `string` | No | — | Type of the response object. |
| `result.data.has_more` | `boolean` | No | — | Indicates if there are more results available. |
| `result.data.data` | `array` | No | — | Array containing suppression information. |
| `result.data.data[].id` | `string` | No | — | Unique identifier for the suppression. |
| `result.data.data[].email` | `string` | No | — | Email address that is suppressed. |
| `result.data.data[].origin` | `"bounce" \| "complaint" \| "manual"` | No | — | Origin of the suppression. Allowed: `bounce`, `complaint`, `manual`. |
| `result.data.data[].source_id` | `string \| null` | No | — | Identifier of the event that caused the suppression, such as the email that bounced or complained. |
| `result.data.data[].created_at` | `string` | No | — | Timestamp indicating when the suppression was created. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "description": "Type of the response object."
          },
          "has_more": {
            "type": "boolean",
            "description": "Indicates if there are more results available."
          },
          "data": {
            "type": "array",
            "description": "Array containing suppression information.",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the suppression."
                },
                "email": {
                  "type": "string",
                  "description": "Email address that is suppressed."
                },
                "origin": {
                  "type": "string",
                  "description": "Origin of the suppression.",
                  "enum": [
                    "bounce",
                    "complaint",
                    "manual"
                  ]
                },
                "source_id": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Identifier of the event that caused the suppression, such as the email that bounced or complained."
                },
                "created_at": {
                  "type": "string",
                  "description": "Timestamp indicating when the suppression was created."
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Connect integrations](https://deepline.com/docs/integrations.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.