> ## 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: List Email Accounts

> Retrieves a collection of email accounts associated with the authenticated workspace. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Retrieves a collection of email accounts associated with the authenticated workspace.

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

## 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_list_email_accounts',
  {
    "search": "software companies hiring engineers",
    "tag_ids": [
      123
    ],
    "excluded_tag_ids": [
      123
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_list_email_accounts --input '{
  "search": "software companies hiring engineers",
  "tag_ids": [
    123
  ],
  "excluded_tag_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": {
    "data": [
      {
        "id": 123,
        "name": "Example",
        "email": "jane.doe@example.com"
      }
    ],
    "links": {
      "first": "example",
      "last": "example",
      "prev": "example"
    },
    "meta": {
      "current_page": 123,
      "from": 123,
      "last_page": 123
    }
  }
}
```

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

## Input reference

Retrieves a collection of email accounts associated with the authenticated workspace.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.search` | `string` | No | — | Search term for filter by. |
| `payload.tag_ids` | `array` | No | — | Array of tag IDs to filter by. |
| `payload.excluded_tag_ids` | `array` | No | — | Exclude email accounts by tag IDs. |
| `payload.without_tags` | `boolean` | No | — | Only show email accounts that have no tags attached. |
| `payload.status` | `"connected" \| "not_connected" \| "pending_move" \| "pending_deletion"` | No | — | The status of the email account. Allowed: `connected`, `not_connected`, `pending_move`, `pending_deletion`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves a collection of email accounts associated with the authenticated workspace.",
    "properties": {
      "search": {
        "type": [
          "string",
          "null"
        ],
        "description": "Search term for filter by."
      },
      "tag_ids": {
        "type": "array",
        "description": "Array of tag IDs to filter by.",
        "items": {
          "type": "integer"
        }
      },
      "excluded_tag_ids": {
        "type": "array",
        "description": "Exclude email accounts by tag IDs.",
        "items": {
          "type": "integer"
        }
      },
      "without_tags": {
        "type": "boolean",
        "description": "Only show email accounts that have no tags attached."
      },
      "status": {
        "type": "string",
        "description": "The status of the email account.",
        "enum": [
          "connected",
          "not_connected",
          "pending_move",
          "pending_deletion"
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].id` | `integer` | No | — | — |
| `result.data.data[].name` | `string` | No | — | — |
| `result.data.data[].email` | `string` | No | — | — |
| `result.data.data[].email_signature` | `string` | No | — | — |
| `result.data.data[].imap_server` | `string` | No | — | — |
| `result.data.data[].imap_port` | `integer` | No | — | — |
| `result.data.data[].smtp_server` | `string` | No | — | — |
| `result.data.data[].smtp_port` | `integer` | No | — | — |
| `result.data.data[].daily_limit` | `integer` | No | — | — |
| `result.data.data[].type` | `string` | No | — | — |
| `result.data.data[].status` | `string` | No | — | — |
| `result.data.data[].warmup_enabled` | `boolean` | No | — | — |
| `result.data.data[].emails_sent_count` | `integer` | No | — | — |
| `result.data.data[].total_replied_count` | `integer` | No | — | — |
| `result.data.data[].total_opened_count` | `integer` | No | — | — |
| `result.data.data[].unsubscribed_count` | `integer` | No | — | — |
| `result.data.data[].bounced_count` | `integer` | No | — | — |
| `result.data.data[].unique_replied_count` | `integer` | No | — | — |
| `result.data.data[].unique_opened_count` | `integer` | No | — | — |
| `result.data.data[].total_leads_contacted_count` | `integer` | No | — | — |
| `result.data.data[].interested_leads_count` | `integer` | No | — | — |
| `result.data.data[].created_at` | `string` | No | — | — |
| `result.data.data[].updated_at` | `string` | No | — | — |
| `result.data.data[].tags` | `array` | No | — | — |
| `result.data.data[].tags[].id` | `integer` | No | — | — |
| `result.data.data[].tags[].name` | `string` | No | — | — |
| `result.data.data[].tags[].default` | `boolean` | No | — | — |
| `result.data.links` | `object` | No | — | — |
| `result.data.links.first` | `string` | No | — | — |
| `result.data.links.last` | `string` | No | — | — |
| `result.data.links.prev` | `string` | No | — | — |
| `result.data.links.next` | `string` | No | — | — |
| `result.data.meta` | `object` | No | — | — |
| `result.data.meta.current_page` | `integer` | No | — | — |
| `result.data.meta.from` | `integer` | No | — | — |
| `result.data.meta.last_page` | `integer` | No | — | — |
| `result.data.meta.links` | `array` | No | — | — |
| `result.data.meta.links[].url` | `string` | No | — | — |
| `result.data.meta.links[].label` | `string` | No | — | — |
| `result.data.meta.links[].active` | `boolean` | No | — | — |
| `result.data.meta.path` | `string` | No | — | — |
| `result.data.meta.per_page` | `integer` | No | — | — |
| `result.data.meta.to` | `integer` | No | — | — |
| `result.data.meta.total` | `integer` | No | — | — |
| `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": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "email_signature": {
                  "type": "string"
                },
                "imap_server": {
                  "type": "string"
                },
                "imap_port": {
                  "type": "integer"
                },
                "smtp_server": {
                  "type": "string"
                },
                "smtp_port": {
                  "type": "integer"
                },
                "daily_limit": {
                  "type": "integer"
                },
                "type": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                },
                "warmup_enabled": {
                  "type": "boolean"
                },
                "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"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer"
                      },
                      "name": {
                        "type": "string"
                      },
                      "default": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "first": {
                "type": "string"
              },
              "last": {
                "type": "string"
              },
              "prev": {
                "type": "string"
              },
              "next": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "meta": {
            "type": "object",
            "properties": {
              "current_page": {
                "type": "integer"
              },
              "from": {
                "type": "integer"
              },
              "last_page": {
                "type": "integer"
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string"
                    },
                    "label": {
                      "type": "string"
                    },
                    "active": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "path": {
                "type": "string"
              },
              "per_page": {
                "type": "integer"
              },
              "to": {
                "type": "integer"
              },
              "total": {
                "type": "integer"
              }
            },
            "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.