> ## 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: Broadcasts Recipients

> Retrieve broadcast recipients. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Retrieve broadcast recipients.

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

## 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_broadcasts_recipients',
  {
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "type": "sent"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run resend_broadcasts_recipients --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000",
  "type": "sent"
}'
```

## 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",
        "contact_id": "contact_123",
        "email": "jane.doe@example.com"
      }
    ]
  }
}
```

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

## Input reference

Retrieve the recipients of a broadcast for a given event type, such as who opened, clicked, or bounced.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | The Broadcast ID. Format: `uuid`. |
| `payload.type` | `"sent" \| "delivered" \| "opened" \| "clicked" \| "bounced" \| "complained" \| "unsubscribed" \| "suppressed"` | Yes | — | The recipient event type to filter by. Allowed: `sent`, `delivered`, `opened`, `clicked`, `bounced`, `complained`, `unsubscribed`, `suppressed`. |
| `payload.email` | `string` | No | — | Filter recipients whose email address contains this value. |
| `payload.bounce_type` | `"permanent" \| "transient" \| "undetermined"` | No | — | Filter bounced recipients by bounce type. Only valid when `type` is `bounced`. Allowed: `permanent`, `transient`, `undetermined`. |
| `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 the recipients of a broadcast for a given event type, such as who opened, clicked, or bounced.",
    "properties": {
      "id": {
        "type": "string",
        "description": "The Broadcast ID.",
        "format": "uuid"
      },
      "type": {
        "type": "string",
        "description": "The recipient event type to filter by.",
        "enum": [
          "sent",
          "delivered",
          "opened",
          "clicked",
          "bounced",
          "complained",
          "unsubscribed",
          "suppressed"
        ]
      },
      "email": {
        "type": "string",
        "description": "Filter recipients whose email address contains this value."
      },
      "bounce_type": {
        "type": "string",
        "description": "Filter bounced recipients by bounce type. Only valid when `type` is `bounced`.",
        "enum": [
          "permanent",
          "transient",
          "undetermined"
        ]
      },
      "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": [
      "id",
      "type"
    ],
    "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 broadcast recipients. |
| `result.data.data[].id` | `string` | No | — | Opaque cursor identifying this row, used for pagination. |
| `result.data.data[].contact_id` | `string \| null` | No | — | The ID of the contact associated with this recipient, if one exists. |
| `result.data.data[].email` | `string` | No | — | The recipient's email address. |
| `result.data.data[].count` | `integer` | No | — | The number of times this recipient triggered the event. Only present when `type` is `opened` or `clicked`. |
| `result.data.data[].bounce_type` | `"permanent" \| "transient" \| "undetermined"` | No | — | The type of bounce. Only present when `type` is `bounced`. Allowed: `permanent`, `transient`, `undetermined`. |
| `result.data.data[].clicked_links` | `array` | No | — | The links this recipient clicked. Only present when `type` is `clicked`. |
| `result.data.data[].clicked_links[].url` | `string` | No | — | The clicked URL. |
| `result.data.data[].clicked_links[].clicks` | `integer` | No | — | The number of times this recipient clicked this URL. |
| `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 broadcast recipients.",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Opaque cursor identifying this row, used for pagination."
                },
                "contact_id": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The ID of the contact associated with this recipient, if one exists."
                },
                "email": {
                  "type": "string",
                  "description": "The recipient's email address."
                },
                "count": {
                  "type": "integer",
                  "description": "The number of times this recipient triggered the event. Only present when `type` is `opened` or `clicked`."
                },
                "bounce_type": {
                  "type": "string",
                  "description": "The type of bounce. Only present when `type` is `bounced`.",
                  "enum": [
                    "permanent",
                    "transient",
                    "undetermined"
                  ]
                },
                "clicked_links": {
                  "type": "array",
                  "description": "The links this recipient clicked. Only present when `type` is `clicked`.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string",
                        "description": "The clicked URL."
                      },
                      "clicks": {
                        "type": "integer",
                        "description": "The number of times this recipient clicked this URL."
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "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.