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,
queued,
scheduled,
running,
paused,
completed,
completed_with_errors,
partially_failed,
failed,
cancelled
record_count
integer
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
priority
enum<string> | null
Available options:
normal,
high
pacing
PacingPolicy · object | null

A ceiling on how fast a batch may be released: N records every M minutes.

The rate is a hard ceiling over any interval — there is no catch-up burst. After a pause, an exhausted provider quota or a closed delivery window, delivery resumes at the configured rate from that moment; the time lost is not made up.

period_minutes is measured in whole minutes: pacing finer than a minute cannot be expressed. Add a window to confine delivery to particular local hours.