Get batch execution status | Runtype Documentation

Returns the current status and progress of a batch execution.

AuthorizationBearer

API key or Clerk session token

idstringRequired

Batch execution ID

Batch status

batchExecutionIdstring

failedRecordsinteger

flowIdstring

processedRecordsinteger

startedAtstring

statusstring

totalRecordsinteger

completedAtstring

progressinteger

resultslist of any

successCountinteger

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	{
2	"batchExecutionId": "b7f3c9d2-4a1e-4f8a-9c3e-2d5a7f6b8e9c",
3	"failedRecords": 2,
4	"flowId": "flow_9a8b7c6d5e4f3g2h1i0j",
5	"processedRecords": 50,
6	"startedAt": "2024-06-10T15:30:00Z",
7	"status": "completed",
8	"totalRecords": 50,
9	"completedAt": "2024-06-10T16:45:00Z",
10	"progress": 100,
11	"results": [
12	null
13	],
14	"successCount": 48
15	}

$	curl https://api.runtype.com/v1/batch/status/id \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"