Skip to main content
GET
Get async bulk submission status

How bulk status works

After submitting a bulk request, the response transitions through two states:
  • processing — At least one item is still being created. summary.processing shows how many are in flight.
  • completed — All items have reached a final processing state (created or failed). Optional webhook-related fields may still appear on items later.
Poll this endpoint until status = "completed". If you provided a webhook_url, you can also listen for the bulk_completed webhook, but poll this endpoint to confirm completion even if individual webhook deliveries fail. For webhookless (poll-only) submissions, this endpoint is the tracking surface for every outcome, including failures.

Bulk priority

The top-level priority is "low", "normal" or "high", as set at submission. Bulks submitted without one, including older bulks, return "normal". See Set a priority for your bulks. radars[] follows your submitted item order, not the order items finish in.

Per-item fields

Each submitted item appears in radars[]. While it is running, the item contains only its index, custom fields, and processing status. Once it settles, the item contains its update_id and update_type, plus either the created radar under data or the item-level error fields. Use status to tell running, created and failed items apart. Optional webhook-related fields. After an item’s webhook is delivered, the item may also include record_id, bulk_id and completed_at. Items with status "success" may also include code (201) and message; items with status "error" may also include discovered_at. Don’t rely on these fields when polling. Items are always returned ordered by item_index.
Re-fetch until the top-level status is "completed". The radars[] array includes all submitted items from the start; in-flight stubs are replaced by their success or failure fields as processing completes.

Authorizations

x-api-key
string
header
required

Path Parameters

bulk_id
string<uuid>
required

Bulk submission ID returned by POST /v1/radars/bulk

Response

Bulk status retrieved successfully

status
enum<string>
required
Available options:
processing,
completed
code
enum<integer>
required
Available options:
200
message
string
required
timestamp
string<date-time>
required
bulk_id
string<uuid>
required
priority
enum<string>
required

Effective priority set at submission; normal when omitted, including older bulks.

Available options:
low,
normal,
high
summary
object
required
radars
object[]
required