Skip to main content
GET
Get Batch

Authorizations

x-api-key
string
header
required

Headers

authorization
string | null
x-api-key
string | null
X-Tenant-ID
string | null

Path Parameters

batch_id
string<uuid>
required

Response

Successful Response

Response for batch status query.

batch_id
string<uuid>
required

ID of the batch

status
string
required

Current status of the batch

total_items
integer
required

Total number of items in the batch

completed_items
integer
required

Number of completed items

failed_items
integer
required

Number of failed items

created_at
string<date-time>
required

When the batch was created

resource_type
string
default:structure

Resource type used for processing

resource_id
string<uuid> | null

Structure ID used for processing

resource_version_number
integer | null

Structure version number used

completed_at
string<date-time> | null

When the batch completed

items
BatchItemStatus · object[]

List of batch items with their processing status and results

failed_webhooks
WebhookDeliveryInfo · object[]

Failed webhook deliveries (for debugging)