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

# Amplemarket Get Mailboxes: Inputs, Cost & CLI Example

> List mailboxes. Amplemarket Amplemarket Get Mailboxes docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## 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=amplemarket_get_mailboxes:{}' --json
```

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

## Input Schema

| Name                     | Type                                                | Required | Default | Description                                                                                                       |
| ------------------------ | --------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `payload.page`           | `object`                                            | No       |         | Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations. |
| `payload.status`         | `"active" \| "inactive" \| "needs_reconnection"`    | No       |         | Filter by mailbox status                                                                                          |
| `payload.email_provider` | `"google" \| "outlook" \| "other" \| "other_mixed"` | No       |         | Filter by email provider                                                                                          |
| `payload.user_email`     | `string`                                            | No       |         | Filter by user email                                                                                              |

### Allowed values

| Field                    | Allowed values                              |
| ------------------------ | ------------------------------------------- |
| `payload.status`         | `active`, `inactive`, `needs_reconnection`  |
| `payload.email_provider` | `google`, `outlook`, `other`, `other_mixed` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "List mailboxes",
    "properties": {
      "page": {
        "type": "object",
        "description": "Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations.",
        "properties": {
          "size": {
            "type": [
              "integer",
              "string"
            ],
            "description": "Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations."
          },
          "after": {
            "type": "string",
            "description": "Page after"
          },
          "before": {
            "type": "string",
            "description": "Page before"
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "status": {
        "type": "string",
        "description": "Filter by mailbox status",
        "enum": [
          "active",
          "inactive",
          "needs_reconnection"
        ]
      },
      "email_provider": {
        "type": "string",
        "description": "Filter by email provider",
        "enum": [
          "google",
          "outlook",
          "other",
          "other_mixed"
        ]
      },
      "user_email": {
        "type": "string",
        "description": "Filter by user email"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | 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": "object",
        "description": "Provider response payload.",
        "properties": {
          "mailboxes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "email_provider": {
                  "type": "string",
                  "enum": [
                    "google",
                    "outlook",
                    "other",
                    "other_mixed"
                  ]
                },
                "daily_email_limit": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "active",
                    "inactive",
                    "needs_reconnection"
                  ]
                },
                "user": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "email": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "created_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "updated_at": {
                  "type": "string",
                  "format": "date-time"
                }
              },
              "additionalProperties": false
            }
          },
          "_links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ],
                "additionalProperties": false
              },
              "prev": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ],
                "additionalProperties": false
              },
              "next": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "self"
            ],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "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 amplemarket_get_mailboxes --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`.