Skip to main content
GET
Get contact import

Authorizations

Authorization
string
header
required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string<uuid>
required

The tenant the import belongs to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
importID
string<uuid>
required

The import to read.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Response for status 200.

acceptedRows
number
required

Contacts written.

completedAt
string<date-time> | null
required
createdAt
string<date-time>
required
errorMessage
string | null
required

Set only when the import as a whole failed.

failedAt
string<date-time> | null
required
fileName
string
required
hasAcceptedReport
boolean
required

Whether the accepted-rows report is available for download.

hasRefusedReport
boolean
required

Whether the refused-rows report is available for download.

importID
string
required
importStatus
string
required

pending | processing | completed | failed.

importTag
string | null
required
percentage
number | null
required

0-100, or null while the row total is still unknown.

processedRows
number
required

Rows read from the file so far.

refusedByCode
object
required

Refused rows keyed by error code (E100, E110, …).

refusedRows
number
required

Rows refused, for any reason.

totalRows
number | null
required

Null until the file has been fully read — the UI shows "counting" rather than "0 of 0".