> ## 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.

# EmailBison: Get Scheduled Email

> Get one scheduled campaign email from EmailBison by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one scheduled campaign email from EmailBison by its ID.

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

## 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(
  'emailbison_get_scheduled_email',
  {
    "id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_get_scheduled_email --input '{
  "id": 123
}' --json
```

## 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": {
    "data": {
      "id": 123,
      "campaign_id": 123,
      "sequence_step_id": 123
    }
  }
}
```

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

## Input reference

This endpoint retrieves a single scheduled (campaign) email.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `integer` | Yes | — | The ID of the scheduled email. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint retrieves a single scheduled (campaign) email.",
    "properties": {
      "id": {
        "type": "integer",
        "description": "The ID of the scheduled email."
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.id` | `integer` | No | — | — |
| `result.data.data.campaign_id` | `integer` | No | — | — |
| `result.data.data.sequence_step_id` | `integer` | No | — | — |
| `result.data.data.thread_reply` | `boolean` | No | — | — |
| `result.data.data.email_subject` | `string` | No | — | — |
| `result.data.data.email_body` | `string` | No | — | — |
| `result.data.data.status` | `string` | No | — | — |
| `result.data.data.scheduled_date` | `string` | No | — | — |
| `result.data.data.scheduled_date_local` | `string` | No | — | — |
| `result.data.data.sent_at` | `string` | No | — | — |
| `result.data.data.opens` | `integer` | No | — | — |
| `result.data.data.clicks` | `integer` | No | — | — |
| `result.data.data.replies` | `integer` | No | — | — |
| `result.data.data.interested` | `boolean` | No | — | — |
| `result.data.data.unique_replies` | `integer` | No | — | — |
| `result.data.data.unique_opens` | `integer` | No | — | — |
| `result.data.data.raw_message_id` | `string` | No | — | — |
| `result.data.data.campaign` | `object` | No | — | — |
| `result.data.data.campaign.id` | `integer` | No | — | — |
| `result.data.data.campaign.uuid` | `string` | No | — | — |
| `result.data.data.campaign.sequence_id` | `integer` | No | — | — |
| `result.data.data.campaign.name` | `string` | No | — | — |
| `result.data.data.campaign.type` | `string` | No | — | — |
| `result.data.data.campaign.status` | `string` | No | — | — |
| `result.data.data.campaign.completion_percentage` | `number` | No | — | — |
| `result.data.data.campaign.emails_sent` | `integer` | No | — | — |
| `result.data.data.campaign.opened` | `integer` | No | — | — |
| `result.data.data.campaign.unique_opens` | `integer` | No | — | — |
| `result.data.data.campaign.replied` | `integer` | No | — | — |
| `result.data.data.campaign.unique_replies` | `integer` | No | — | — |
| `result.data.data.campaign.bounced` | `integer` | No | — | — |
| `result.data.data.campaign.unsubscribed` | `integer` | No | — | — |
| `result.data.data.campaign.interested` | `integer` | No | — | — |
| `result.data.data.campaign.total_leads_contacted` | `integer` | No | — | — |
| `result.data.data.campaign.max_emails_per_day` | `integer` | No | — | — |
| `result.data.data.campaign.max_new_leads_per_day` | `integer` | No | — | — |
| `result.data.data.campaign.plain_text` | `boolean` | No | — | — |
| `result.data.data.campaign.open_tracking` | `boolean` | No | — | — |
| `result.data.data.campaign.total_leads` | `string` | No | — | — |
| `result.data.data.campaign.can_unsubscribe` | `boolean` | No | — | — |
| `result.data.data.campaign.unsubscribe_text` | `string` | No | — | — |
| `result.data.data.campaign.include_auto_replies_in_stats` | `boolean` | No | — | — |
| `result.data.data.campaign.created_at` | `string` | No | — | — |
| `result.data.data.campaign.updated_at` | `string` | No | — | — |
| `result.data.data.lead` | `object` | No | — | — |
| `result.data.data.lead.id` | `integer` | No | — | — |
| `result.data.data.lead.first_name` | `string` | No | — | — |
| `result.data.data.lead.last_name` | `string` | No | — | — |

The table shows the first 50 fields. Expand the raw schema below for every field.

<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": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "campaign_id": {
                "type": "integer"
              },
              "sequence_step_id": {
                "type": "integer"
              },
              "thread_reply": {
                "type": "boolean"
              },
              "email_subject": {
                "type": "string"
              },
              "email_body": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "scheduled_date": {
                "type": "string"
              },
              "scheduled_date_local": {
                "type": "string"
              },
              "sent_at": {
                "type": "string"
              },
              "opens": {
                "type": "integer"
              },
              "clicks": {
                "type": "integer"
              },
              "replies": {
                "type": "integer"
              },
              "interested": {
                "type": "boolean"
              },
              "unique_replies": {
                "type": "integer"
              },
              "unique_opens": {
                "type": "integer"
              },
              "raw_message_id": {
                "type": "string"
              },
              "campaign": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "uuid": {
                    "type": "string"
                  },
                  "sequence_id": {
                    "type": "integer"
                  },
                  "name": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "completion_percentage": {
                    "type": "number"
                  },
                  "emails_sent": {
                    "type": "integer"
                  },
                  "opened": {
                    "type": "integer"
                  },
                  "unique_opens": {
                    "type": "integer"
                  },
                  "replied": {
                    "type": "integer"
                  },
                  "unique_replies": {
                    "type": "integer"
                  },
                  "bounced": {
                    "type": "integer"
                  },
                  "unsubscribed": {
                    "type": "integer"
                  },
                  "interested": {
                    "type": "integer"
                  },
                  "total_leads_contacted": {
                    "type": "integer"
                  },
                  "max_emails_per_day": {
                    "type": "integer"
                  },
                  "max_new_leads_per_day": {
                    "type": "integer"
                  },
                  "plain_text": {
                    "type": "boolean"
                  },
                  "open_tracking": {
                    "type": "boolean"
                  },
                  "total_leads": {
                    "type": "string"
                  },
                  "can_unsubscribe": {
                    "type": "boolean"
                  },
                  "unsubscribe_text": {
                    "type": "string"
                  },
                  "include_auto_replies_in_stats": {
                    "type": "boolean"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "updated_at": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "lead": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "first_name": {
                    "type": "string"
                  },
                  "last_name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  },
                  "title": {
                    "type": "string"
                  },
                  "company": {
                    "type": "string"
                  },
                  "notes": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "custom_variables": {
                    "type": "array"
                  },
                  "overall_stats": {
                    "type": "object",
                    "properties": {
                      "emails_sent": {
                        "type": "integer"
                      },
                      "opens": {
                        "type": "integer"
                      },
                      "replies": {
                        "type": "integer"
                      },
                      "unique_replies": {
                        "type": "integer"
                      },
                      "unique_opens": {
                        "type": "integer"
                      }
                    },
                    "additionalProperties": false
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "updated_at": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "sender_email": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  },
                  "email_signature": {
                    "type": "string"
                  },
                  "imap_server": {
                    "type": "string"
                  },
                  "imap_port": {
                    "type": "string"
                  },
                  "smtp_server": {
                    "type": "string"
                  },
                  "smtp_port": {
                    "type": "string"
                  },
                  "daily_limit": {
                    "type": "integer"
                  },
                  "type": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "emails_sent_count": {
                    "type": "integer"
                  },
                  "total_replied_count": {
                    "type": "integer"
                  },
                  "total_opened_count": {
                    "type": "integer"
                  },
                  "unsubscribed_count": {
                    "type": "integer"
                  },
                  "bounced_count": {
                    "type": "integer"
                  },
                  "unique_replied_count": {
                    "type": "integer"
                  },
                  "unique_opened_count": {
                    "type": "integer"
                  },
                  "total_leads_contacted_count": {
                    "type": "integer"
                  },
                  "interested_leads_count": {
                    "type": "integer"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "updated_at": {
                    "type": "string"
                  }
                },
                "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

* [EmailBison provider guide](https://deepline.com/docs/providers/emailbison/guide.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.