Get batch

Fetch aggregate progress for a batch.

GET /api/v2/batches/{batch_id}

Path parameters

string

required

The batch_id returned by POST /api/v2/batch/deep (or /batch/quick).

Response

string

required

The batch id you requested.

string

required

processing while any profile is in flight; completed once every profile has reached a terminal status.

integer

required

Count of profiles in the batch.

integer

required

Count of profiles whose scans completed successfully. See Status values.

integer

required

Count of profiles whose scans failed.

integer

required

Count of profiles still processing.

string

required

ISO 8601 UTC timestamp of when the batch was submitted.

string

ISO 8601 UTC timestamp of when the last profile reached a terminal status. null while the batch is still processing.

string[]

required

The profile URLs the batch was submitted with, in submission order.

Example

curl https://api-v2.tumban.com/api/v2/batches/9b8a7c6d-1234-5678-9abc-def012345678 \
  -H "Authorization: Bearer sk_xxx"

{
  "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.

Get started

Core concepts

API reference

Webhooks

Reference

Path parameters

Response

Example

Errors

​Path parameters

​Response

​Example

​Errors

Path parameters

Response

Example

Errors