> ## 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 All Scheduled Emails API Scheduled Emails

> This endpoint retrieves all scheduled (campaign) emails. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

This endpoint retrieves all scheduled (campaign) emails.

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

## 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_all_scheduled_emails_api_scheduled_emails',
  {
    "status": "sent",
    "campaign_ids": [
      123
    ],
    "lead_ids": [
      123
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_get_all_scheduled_emails_api_scheduled_emails --input '{
  "status": "sent",
  "campaign_ids": [
    123
  ],
  "lead_ids": [
    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": "example"
}
```

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

## Input reference

This endpoint retrieves all scheduled (campaign) emails.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.status` | `"sent" \| "scheduled" \| "failed" \| "paused" \| "stopped" \| "bounced" \| "unsubscribed"` | No | — | The status of the scheduled email. Allowed: `sent`, `scheduled`, `failed`, `paused`, `stopped`, `bounced`, `unsubscribed`. |
| `payload.campaign_ids` | `array` | No | — | Campaign IDs to filter by. |
| `payload.lead_ids` | `array` | No | — | Lead IDs to filter by. |
| `payload.sender_email_ids` | `array` | No | — | Sender Email IDs to filter by. |
| `payload.scheduled_date_local` | `object` | No | — | — |
| `payload.scheduled_date_local.value` | `string` | No | — | The date the email was/is scheduled to be sent at. The timezone is the campaign's timezone. The format is YYYY-MM-DD. |
| `payload.scheduled_date_local.criteria` | `"<" \| "<=" \| "=" \| ">" \| ">="` | No | — | The criteria for the scheduled\_date\_local. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint retrieves all scheduled (campaign) emails.",
    "properties": {
      "status": {
        "type": "string",
        "description": "The status of the scheduled email.",
        "enum": [
          "sent",
          "scheduled",
          "failed",
          "paused",
          "stopped",
          "bounced",
          "unsubscribed"
        ]
      },
      "campaign_ids": {
        "type": "array",
        "description": "Campaign IDs to filter by.",
        "items": {
          "type": "integer"
        }
      },
      "lead_ids": {
        "type": "array",
        "description": "Lead IDs to filter by.",
        "items": {
          "type": "integer"
        }
      },
      "sender_email_ids": {
        "type": "array",
        "description": "Sender Email IDs to filter by.",
        "items": {
          "type": "integer"
        }
      },
      "scheduled_date_local": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "scheduled_date_local.value": {
        "type": "string",
        "description": "The date the email was/is scheduled to be sent at. The timezone is the campaign's timezone. The format is YYYY-MM-DD."
      },
      "scheduled_date_local.criteria": {
        "type": "string",
        "description": "The criteria for the scheduled_date_local.",
        "enum": [
          "<",
          "<=",
          "=",
          ">",
          ">="
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `string` | Yes | — | Provider response payload. |
| `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": "string",
        "description": "Provider response payload."
      },
      "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.