Skip to main content
GET
Get one InboxKit import run

Authorizations

X-API-Key
string
header
required

Path Parameters

run_id
string<uuid>
required

Response

Successful Response

failed_count
integer
required
finished_at
string<date-time> | null
required
id
string<uuid>
required
imported_count
integer
required
items
InboxkitImportRunItemReadSchema · object[]
required
requested_count
integer
required
skipped_count
integer
required
started_at
string<date-time>
required
status
enum<string>
required

Where one import request stands.

RUNNING until every item reaches a terminal state; then SUCCEEDED when everything imported, FAILED when nothing did, PARTIAL for the mix. Status and counts are always derived from items. Three independent paths (the synchronous import, the authorize workflow's import, and its failure branches) finalize items, so denormalized counters would drift.

Available options:
running,
succeeded,
partial,
failed
trigger
enum<string>
required

Who asked for the import: a person in the picker, or the hourly sweep.

Available options:
manual,
auto