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

# Openmart: Get Batch Status

> Check the progress of a batch of people, email or technology lookup tasks, given its batch ID. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Check the progress of a batch of people, email or technology lookup tasks, given its batch ID.

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

## 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(
  'openmart_get_batch_status',
  {
    "batch_id": "batch_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute openmart_get_batch_status --input '{
  "batch_id": "batch_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": {
    "processing": 123,
    "completed": 123,
    "errored": 123,
    "total": 123,
    "batch_ready": true
  }
}
```

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

## Input reference

Poll aggregate progress for a batch until batch\_ready is true.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.batch_id` | `string` | Yes | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Poll aggregate progress for a batch until batch_ready is true.",
    "properties": {
      "batch_id": {
        "type": "string"
      }
    },
    "required": [
      "batch_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.processing` | `integer` | Yes | — | — |
| `result.data.completed` | `integer` | Yes | — | — |
| `result.data.errored` | `integer` | Yes | — | — |
| `result.data.total` | `integer` | Yes | — | — |
| `result.data.batch_ready` | `boolean` | 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": {
          "processing": {
            "type": "integer"
          },
          "completed": {
            "type": "integer"
          },
          "errored": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          },
          "batch_ready": {
            "type": "boolean"
          }
        },
        "required": [
          "processing",
          "completed",
          "errored",
          "total",
          "batch_ready"
        ],
        "additionalProperties": true
      },
      "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

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