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

# BounceBan: Get Bulk Status

> Read, export, or manage an existing BounceBan bulk verification task. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Read, export, or manage an existing BounceBan bulk verification task.

<Info>
  Tool ID: `bounceban_get_bulk_status`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'bounceban_get_bulk_status',
  {
    "id": "id_123"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute bounceban_get_bulk_status --input '{
  "id": "id_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "id": "id_123",
    "status": "importing",
    "total_count": 123
  }
}
```

Use `deepline tools get bounceban_get_bulk_status --json` for the latest machine-readable contract.

## Input reference

You can use this API to get the latest progress and stats for a bulk email verification task using a task ID.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Bulk email verification task id. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "You can use this API to get the latest progress and stats for a bulk email verification task using a task ID.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Bulk email verification task id."
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | No | — | Bulk email verification task id. |
| `result.data.status` | `"importing" \| "verifying" \| "finished"` | No | — | Bulk email verification task status. > `importing` indicates the list of emails are being imported for verification. > `verifying` indicates all the emails are imported and are being verified. > `finished` indicates verification for the whole list has finished. Allowed: `importing`, `verifying`, `finished`. |
| `result.data.total_count` | `integer` | No | — | If `status` is `importing` or `verifying`, it represents the number of emails for verification; If `status` is `finished`, it represents the number of emails verified. |
| `result.data.finished_count` | `integer` | No | — | It represents the number of emails imported when `status` is `importing`, and the number of emails verified when `status` is `verifying`. |
| `result.data.pushed_count` | `integer` | No | — | It represents the number of emails pushed via webhook events. Only returned when `status` is `verifying` or `finished`, and a webhook was submitted when creating the bulk verification task. |
| `result.data.deliverable_count` | `integer` | No | — | It represents the number of emails that are `deliverable`. Only returned when `status` is `finished`. |
| `result.data.undeliverable_count` | `integer` | No | — | It represents the number of emails that are `undeliverable`. Only returned when `status` is `finished`. |
| `result.data.risky_count` | `integer` | No | — | It represents the number of emails that are `risky`. Only returned when `status` is `finished`. |
| `result.data.unknown_count` | `integer` | No | — | It represents the number of emails that are `unknown`. Only returned when `status` is `finished`. |
| `result.data.catchall_count` | `integer` | No | — | It represents the number of emails that are `catchall`. Only returned when `status` is `finished`. |
| `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": {
          "id": {
            "type": "string",
            "description": "Bulk email verification task id."
          },
          "status": {
            "type": "string",
            "description": "Bulk email verification task status. > `importing` indicates the list of emails are being imported for verification. > `verifying` indicates all the emails are imported and are being verified. > `finished` indicates verification for the whole list has finished.",
            "enum": [
              "importing",
              "verifying",
              "finished"
            ]
          },
          "total_count": {
            "type": "integer",
            "description": "If `status` is `importing` or `verifying`, it represents the number of emails for verification; If `status` is `finished`, it represents the number of emails verified."
          },
          "finished_count": {
            "type": "integer",
            "description": "It represents the number of emails imported when `status` is `importing`, and the number of emails verified when `status` is `verifying`."
          },
          "pushed_count": {
            "type": "integer",
            "description": "It represents the number of emails pushed via webhook events. Only returned when `status` is `verifying` or `finished`, and a webhook was submitted when creating the bulk verification task."
          },
          "deliverable_count": {
            "type": "integer",
            "description": "It represents the number of emails that are `deliverable`. Only returned when `status` is `finished`."
          },
          "undeliverable_count": {
            "type": "integer",
            "description": "It represents the number of emails that are `undeliverable`. Only returned when `status` is `finished`."
          },
          "risky_count": {
            "type": "integer",
            "description": "It represents the number of emails that are `risky`. Only returned when `status` is `finished`."
          },
          "unknown_count": {
            "type": "integer",
            "description": "It represents the number of emails that are `unknown`. Only returned when `status` is `finished`."
          },
          "catchall_count": {
            "type": "integer",
            "description": "It represents the number of emails that are `catchall`. Only returned when `status` is `finished`."
          }
        },
        "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

* [BounceBan provider guide](/docs/providers/bounceban/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.