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

> List the sending mailboxes connected to Amplemarket, with their status and email provider. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the sending mailboxes connected to Amplemarket, with their status and email provider.

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

## 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(
  'amplemarket_get_mailboxes',
  {
    "page": {
      "size": 1,
      "after": "cursor_123",
      "before": "cursor_123"
    },
    "status": "active",
    "email_provider": "google"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute amplemarket_get_mailboxes --input '{
  "page": {
    "size": 1,
    "after": "cursor_123",
    "before": "cursor_123"
  },
  "status": "active",
  "email_provider": "google"
}' --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": {
    "mailboxes": [
      {
        "id": "id_123",
        "email": "jane.doe@example.com",
        "email_provider": "google"
      }
    ],
    "_links": {
      "self": {
        "href": "example"
      }
    }
  }
}
```

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

## Input reference

List mailboxes

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `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 Allowed: `active`, `inactive`, `needs_reconnection`. |
| `payload.email_provider` | `"google" \| "outlook" \| "other" \| "other_mixed"` | No | — | Filter by email provider Allowed: `google`, `outlook`, `other`, `other_mixed`. |
| `payload.user_email` | `string` | No | — | Filter by user email |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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 reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.mailboxes` | `array` | No | — | — |
| `result.data.mailboxes[].id` | `string` | No | — | — |
| `result.data.mailboxes[].email` | `string` | No | — | — |
| `result.data.mailboxes[].email_provider` | `"google" \| "outlook" \| "other" \| "other_mixed"` | No | — | Allowed: `google`, `outlook`, `other`, `other_mixed`. |
| `result.data.mailboxes[].daily_email_limit` | `integer \| null` | No | — | — |
| `result.data.mailboxes[].status` | `"active" \| "inactive" \| "needs_reconnection"` | No | — | Allowed: `active`, `inactive`, `needs_reconnection`. |
| `result.data.mailboxes[].user` | `object` | No | — | — |
| `result.data.mailboxes[].user.id` | `string` | No | — | — |
| `result.data.mailboxes[].user.name` | `string \| null` | No | — | — |
| `result.data.mailboxes[].user.email` | `string` | No | — | — |
| `result.data.mailboxes[].created_at` | `string` | No | — | Format: `date-time`. |
| `result.data.mailboxes[].updated_at` | `string` | No | — | Format: `date-time`. |
| `result.data._links` | `object` | No | — | — |
| `result.data._links.self` | `object` | Yes | — | — |
| `result.data._links.self.href` | `string` | Yes | — | — |
| `result.data._links.prev` | `object` | No | — | — |
| `result.data._links.prev.href` | `string` | Yes | — | — |
| `result.data._links.next` | `object` | No | — | — |
| `result.data._links.next.href` | `string` | Yes | — | — |
| `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": {
          "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>

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

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