Skip to main content
GET
Get a batch

Authorizations

X-API-Key
string
header
required

Path Parameters

batch_id
string
required

Response

Successful Response

id
string
required
definition_id
string
required
org_id
string
required
trigger_id
string
required
trigger_type
string
required
metadata
Metadata · object
required
status
enum<string>
required
Available options:
pending,
scheduled,
running,
completed,
partially_failed,
failed,
cancelled
record_count
integer
required
input_data
Input Data · object
required
records
Records · object[]
required
scheduled_at
string<date-time> | null
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
trigger_source
string | null
schedule_id
string | null