Bulk import status

Get live progress and the final outcome of a bulk account+location import (Bulk import accounts + locations (CSV upload)). Poll until status is terminal.

Path params

ParameterTypeRequiredNotes
bulkImportIdintegerRequiredDigits only.

Auth

  • Partner — authentication. Returns the import only when it belongs to the caller's partner (else 404); 403 if the caller is not a partner.

Rate limit

  • No rate limit.

Path

  • id (integer, Required) — the import_id returned by Bulk import accounts + locations (CSV upload).

Response — { data. }

FieldTypeNotes
statusstringqueued, then preparing, then processing, then terminal completed / completed_with_errors / failed.
total_rowsintegerCSV data rows read.
processed_rowsintegerRows that reached a terminal outcome (created + skipped).
created_rowsintegerAccounts successfully provisioned.
skipped_rowsintegerRows skipped (invalid / duplicate / plan_unavailable / unknown_country).
created_citiesintegerNew city reference rows minted during geo resolve.
created_statesintegerNew state reference rows minted during geo resolve.
skip_breakdownobjectMap of skip reason → count, e.g. { "duplicate_email": 1, "plan_unavailable": 2 }.
error_messagestring|nullSet only when status = failed.
queued_at / started_at / completed_attimestamp|nullLifecycle timestamps.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json