Skip to main content
GET
/
v1
/
batches
/
{id}
Get batch detail
curl --request GET \
  --url https://api.runflow.io/v1/batches/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_type_code": "<string>",
  "target_type": "<string>",
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status_code": "<string>",
  "source_code": "<string>",
  "items_total": 123,
  "items_succeeded": 123,
  "items_failed": 123,
  "items_cancelled": 123,
  "input": [
    {}
  ],
  "resolved_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dispatch_provider_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cost": "<string>",
  "output": {},
  "metadata": {},
  "callback_url": "<string>",
  "duration_ms": 123,
  "failure_code": "<string>",
  "failure_message": "<string>",
  "failure_stage_code": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "links": {},
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sequence_index": 123,
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status_code": "<string>",
      "client_ref": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Organization-Id
string | null

Path Parameters

​
id
string<uuid>
required

Response

Successful Response

Response shape.

​
id
string<uuid> | null
​
org_id
string<uuid> | null
​
target_type_code
string | null
​
target_type
string | null
​
target_id
string<uuid> | null
​
status_code
string | null
​
source_code
string | null
​
items_total
integer | null
​
items_succeeded
integer | null
​
items_failed
integer | null
​
items_cancelled
integer | null
​
input
Input · object[] | null
​
resolved_template_id
string<uuid> | null
​
dispatch_provider_link_id
string<uuid> | null
​
cost
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
output
Output · object
​
metadata
Metadata · object
​
callback_url
string | null
​
duration_ms
integer | null
​
failure_code
string | null
​
failure_message
string | null
​
failure_stage_code
string | null
​
created_by
string<uuid> | null
​
created_at
string<date-time> | null
​
started_at
string<date-time> | null
​
completed_at
string<date-time> | null
​
links
Links · object
​
items
BatchItemHandle · object[] | null