Skip to main content
GET
Get an import run

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

importRunId
string<uuid>
required

Import run ID from the execute response.

Response

Import run status and counters.

An import run: status, chunked-processing progress, and per-outcome row counts.

import_run_id
string<uuid>
required

Import run ID.

import_session_id
string<uuid>
required

The import session the run was created from.

status
enum<string>
required

Run state. queuedrunningcompleted or failed.

Available options:
queued,
running,
completed,
failed
requested_by_user_id
string
required

Who started the run. tented-api for runs started via this API.

duplicate_strategy
enum<string>
required

How rows matching existing contacts were handled.

Available options:
update,
skip
overwrite_blank_only
boolean
required

Whether imported values only filled empty fields on matched contacts.

list_ids
string<uuid>[]
required

Static list IDs imported contacts were added to.

total_rows
integer | null
required

Total data rows in the source file, or null before preprocessing has counted them.

total_chunks
integer
required

Number of processing chunks the file was split into (rows are processed in chunks of up to 1,000).

completed_chunks
integer
required

Chunks processed successfully so far.

failed_chunks
integer
required

Chunks that failed.

processed_rows
integer
required

Data rows processed so far — compare against total_rows for progress.

last_processed_row_number
integer
required

Highest row number processed so far.

created_count
integer
required

Rows that created a new contact.

updated_count
integer
required

Rows that updated an existing contact.

skipped_count
integer
required

Rows skipped (e.g. duplicates under duplicate_strategy: "skip", or rows with no usable identity).

error_count
integer
required

Rows that failed with an error.

started_at
string<date-time> | null
required

When processing started, or null while queued.

completed_at
string<date-time> | null
required

When the run completed, or null.

failed_at
string<date-time> | null
required

When the run failed, or null.

failure_message
string | null
required

Failure reason when status is failed.

created_field_definition_ids
string<uuid>[]
required

Custom fields created during this import's setup.

created_at
string<date-time>
required

Creation time.

updated_at
string<date-time>
required

Last update.

file_name
string

File name associated with the import session.