KintsugiKintsugi

Get an import by id

GET/imports/{import_id}

Fetch a single import by id. Returns 404 if it does not exist or belongs to an organization your credential cannot access.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Narrow the request to one organization (Organization-Id selector).

Connection-Idstring

Narrow the request to a connection's organization.

Entity-Idstring

Narrow the request to a platform entity's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Path parameters

import_idstringRequired

The unique identifier of the import.

Response

idstringRequired

Import id.

organizationIdstringRequired

Organization the import belongs to.

sourcestringRequired

Import source (a connector name, or IMPORT for a manual CSV upload).

importTypePublicImportTypeEnumRequired

TRANSACTIONS for a sales/purchase CSV, PRODUCT_UPDATES for a product bulk-update workbook.

Available options:TRANSACTIONSPRODUCT_UPDATES
directionPublicTransactionDirectionEnum

SALE or PURCHASE for the whole file. null when set per row instead (rows default to SALE).

Available options:SALEPURCHASE
fileNamestring

Original uploaded file name. null until known.

statusPublicImportStatusEnumRequired

Import processing status.

Available options:NEWSUBMITTEDVIRUS_SCAN_FAILEDVALIDATION_SUBMITVALIDATINGVALIDATION_SUCCESSVALIDATION_FAILUREIMPORT_STARTEDIMPORTINGFAILURESUCCESSCANCELLEDCONFIRM_PENDING
rowCountinteger

Total rows in the uploaded file. null until counted.

importedCountinteger

Rows successfully imported as transactions.

skippedCountinteger

Rows skipped during import.

createdAtstringRequired

When the import was created.

updatedAtstring

When the import row last changed.

submittedAtstring

When submit-stage processing started. null until submitted.

validationCompletedAtstring

When validation finished. null until it completes.

validationTruncatedboolean

True when the validation error log was truncated (only the first errors were kept).

validRowCountinteger

Rows that passed validation. null until validation completes.

invalidRowCountinteger

Rows that failed validation. null until validation completes.

ingestCompletedAtstring

When row processing finished. null until it completes.

processedRowCountinteger

Rows processed so far. null when rows are not currently being processed.

ingestedRowCountinteger

Rows imported so far. null when rows are not currently being processed.

failedRowCountinteger

Rows that failed to import so far. null when rows are not currently being processed.

ingestSubmitModestring

ALL or VALID_ONLY, once row processing has been requested. null before then.

failureReasonImportFailureReasonEnum

Why the import failed. One of duplicate_content, virus_scan_failed, upload_unavailable, upload_size_mismatch, unsupported_file_type, invalid_workbook, validation_failed, import_failed. null unless the import failed. Clients must tolerate new values.

Available options:duplicate_contentvirus_scan_failedupload_unavailableupload_size_mismatchunsupported_file_typeinvalid_workbookvalidation_failedimport_failed
failureMessagestring

Plain-language explanation of the failure, safe to show to a person. null when failureReason is null, or when it needs no more detail than the reason itself.

hasErrorFileboolean

True when GET /imports/{importId}/error-file has a validation error file to return.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

422

The request failed validation.

cURL
GET /imports/{import_id}
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/imports/{import_id}
Response
{
"id": "impt_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"source": "API",
"importType": "TRANSACTIONS",
"direction": "SALE",
"fileName": "certificate.pdf",
"status": "NEW",
"rowCount": 1,
"importedCount": 0,
"skippedCount": 0,
"createdAt": "2026-07-28T12:00:00Z",
"updatedAt": "2026-07-28T12:00:00Z",
"submittedAt": "2026-07-28T12:00:00Z",
"validationCompletedAt": "2026-07-28T12:00:00Z",
"validationTruncated": false,
"validRowCount": 1,
"invalidRowCount": 1,
"ingestCompletedAt": "2026-07-28T12:00:00Z",
"processedRowCount": 1,
"ingestedRowCount": 1,
"failedRowCount": 1,
"ingestSubmitMode": "ingest submit mode",
"failureReason": "duplicate_content",
"failureMessage": "failure message",
"hasErrorFile": false
}
Get an import by id (2026-07-21) | Kintsugi API Reference