Skip to main content
GET
Poll a merge batch's status

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

batch_id
integer
required

ID returned by startMergeBatch.

Response

Current batch status.

status
string

pending, processing, completed, failed, or undone.

Example:

"processing"

progress
number<float>
Example:

66.7

total_merges
integer
Example:

12

processed_merges
integer
Example:

8

successful_merges
integer
Example:

7

failed_merges
integer
Example:

1

started_at
string<date-time> | null
completed_at
string<date-time> | null
error_message
string | null
can_be_undone
boolean
Example:

true

ancillary_failed_count
integer
Example:

1

ancillary_pending_count
integer
Example:

0

needs_refresh
boolean
Example:

true