Skip to main content
GET
Retrieve a file import

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Query Parameters

outcome
string

Filter the embedded row errors by outcome

limit
integer
default:50

Page size for the embedded row errors

Required range: 1 <= x <= 200
offset
integer
default:0

Offset for the embedded row errors

Response

The file import, plus an offset-paginated page of its row errors. Successful rows are not listed here — they are real records.

A file import (CSV/NACHA upload or bulk API submission) and its ingestion lifecycle. Aggregate fields (record_count, total_credits, total_debits, net_amount, date_range_start, date_range_end, currency) are merged in only on the stream-scoped index GET /data_streams/{key}/file_imports, and are trustworthy once status is completed.

id
integer
status
enum<string>
Available options:
pending,
processing,
replicating,
completed,
failed,
cancelled
source
string | null

Origin of the import (e.g. csv, nacha, bulk_api)

filename
string | null
total_items
integer
processed_items
integer
successful_items
integer
failed_items
integer
skipped_items
integer

Records skipped due to on_conflict: skip matching an existing external_id

expected_records_count
integer | null
progress
integer

processed_items / total_items as a percentage (0-100)

parsing
boolean

True until rows start landing; file totals are unknown while parsing

decimal_places
integer

Number of decimal places (2 for USD)

stuck
boolean

Currently processing with no heartbeat for >5 minutes

on_conflict
string | null
error_message
string | null
error_details
object | null
data_stream_ids
integer[]
created_at
string<date-time>
started_at
string<date-time> | null
records_written_at
string<date-time> | null
completed_at
string<date-time> | null
last_progress_at
string<date-time> | null
cancellation_requested_at
string<date-time> | null
url
string

e.g. /v1/file_imports/123

records_url
string

e.g. /v1/file_imports/123/records

record_count
integer

Aggregate; stream-scoped index only

total_credits
integer

Aggregate, in cents; stream-scoped index only

total_debits
integer

Aggregate, in cents; stream-scoped index only

net_amount
integer

Aggregate: credits minus debits, in cents; stream-scoped index only

date_range_start
string<date> | null

Aggregate; stream-scoped index only

date_range_end
string<date> | null

Aggregate; stream-scoped index only

currency
string | null

Aggregate; stream-scoped index only

errors
object