> ## 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 Scheduled Emails:

> This endpoint retrieves all scheduled (campaign) emails. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=emailbison_get_all_scheduled_emails_api_scheduled_emails:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                                    | Type                                                                                        | Required | Default | Description                                                                                                           |
| --------------------------------------- | ------------------------------------------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
| `payload.status`                        | `"sent" \| "scheduled" \| "failed" \| "paused" \| "stopped" \| "bounced" \| "unsubscribed"` | No       |         | The status of the scheduled email.                                                                                    |
| `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` | `"&lt;" \| "&lt;=" \| "=" \| "&gt;" \| "&gt;="`                                             | No       |         | The criteria for the scheduled\_date\_local.                                                                          |

### Allowed values

| Field                                   | Allowed values                                                                |
| --------------------------------------- | ----------------------------------------------------------------------------- |
| `payload.status`                        | `sent`, `scheduled`, `failed`, `paused`, `stopped`, `bounced`, `unsubscribed` |
| `payload.scheduled_date_local.criteria` | `<`, `<=`, `=`, `>`, `>=`                                                     |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `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={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute emailbison_get_all_scheduled_emails_api_scheduled_emails --payload '{}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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