> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tumban.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get batch

> Fetch a batch's status and per-status counts.

Fetch aggregate progress for a batch.

```http theme={null}
GET /api/v2/batches/{batch_id}
```

## Path parameters

<ParamField path="batch_id" type="string" required>
  The `batch_id` returned by
  [`POST /api/v2/batch/deep`](/api/scans/batch) (or `/batch/quick`).
</ParamField>

## Response

<ResponseField name="batch_id" type="string" required>
  The batch id you requested.
</ResponseField>

<ResponseField name="status" type="string" required>
  `processing` while any profile is in flight; `completed` once every
  profile has reached a terminal status.
</ResponseField>

<ResponseField name="total_profiles" type="integer" required>
  Count of profiles in the batch.
</ResponseField>

<ResponseField name="completed" type="integer" required>
  Count of profiles whose scans completed successfully. See
  [Status values](/reference/status).
</ResponseField>

<ResponseField name="failed" type="integer" required>
  Count of profiles whose scans failed.
</ResponseField>

<ResponseField name="in_progress" type="integer" required>
  Count of profiles still processing.
</ResponseField>

<ResponseField name="submitted_at" type="string" required>
  ISO 8601 UTC timestamp of when the batch was submitted.
</ResponseField>

<ResponseField name="completed_at" type="string">
  ISO 8601 UTC timestamp of when the last profile reached a terminal
  status. `null` while the batch is still processing.
</ResponseField>

<ResponseField name="profile_urls" type="string[]" required>
  The profile URLs the batch was submitted with, in submission order.
</ResponseField>

## Example

```bash theme={null}
curl https://api-v2.tumban.com/api/v2/batches/9b8a7c6d-1234-5678-9abc-def012345678 \
  -H "Authorization: Bearer sk_xxx"
```

```json theme={null}
{
  "batch_id": "9b8a7c6d-1234-5678-9abc-def012345678",
  "status": "processing",
  "total_profiles": 3,
  "completed": 1,
  "failed": 0,
  "in_progress": 2,
  "submitted_at": "2026-04-29T12:00:00.123456+00:00",
  "completed_at": null,
  "profile_urls": [
    "https://creator.example/alice",
    "https://creator.example/bob",
    "https://creator.example/carol"
  ]
}
```

## Errors

| Status | Detail                                                                    |
| ------ | ------------------------------------------------------------------------- |
| 404    | `Batch not found` — the batch id does not exist within your organization. |