Skip to main content
GET
Get Import Status

Get Import Status

Retrieve the current lifecycle status and validation summary of an import session. Use this to check whether a session is ready to submit, or to monitor progress after submission.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the import sessionExample: "11111111-1111-1111-1111-111111111111"

Response

string
UUID of the import session
string
Current lifecycle statusValues: created, parsed, mapped, validating, validated, submitting, submitted, failed, expired
string
Backend template identifier used for this import
string
Original filename of the uploaded file
string | null
Numeric locale applied during parsing
string | null
Date locale applied (dmy or mdy)
integer
Total number of data rows
integer
Number of rows that passed validation
integer
Number of rows with validation errors
object
Error counts per column key. Example: {"weight_kg": 3, "date": 1}
object | null
Confirmed column mapping ({target_column: source_column}) or null if not yet mapped
string | null
UUID of the file created after submission
string | null
UUID of the downstream processing job started after submission
array[string]
Column headers detected in the source file
datetime
ISO 8601 timestamp when the session was created
string | null
ISO 8601 timestamp of the last update

Example

Successful Response

Session Status Lifecycle

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

403 Forbidden

Cause: The authenticated user is not a member of the organization

404 Not Found

Cause: The import session does not exist or belongs to another organization

Create Session

Upload a file and start a new import

Submit Import

Submit the validated session