DocsAPI ReferenceImport/bff/import/detail
getImportAdmin BFF

/bff/import/detail

Returns full details of a single import job including progress counters, detected columns, and any error messages. Use this endpoint to poll import progress (recommended interval: 10 seconds).

ImportgetBffImportDetail

Parameters

1 query

1 total
Query · 1
importIdstringRequired

External ID of the import job.

Request

GET /bff/import/detail

get
curl -X GET "https://api.bizkithub.com/bff/import/detail?importId=aB3xKm9pQ2wLn4Yz" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Full import job detail with progress and metadata.

{
  "id": 0,
  "organisationId": 0,
  "externalId": "example_externalId",
  "provider": "example_provider",
  "dataType": "example_dataType",
  "sourceType": "example_sourceType",
  "sourceName": "example_sourceName",
  "status": "example_status",
  "totalRows": 0,
  "importedRows": 0,
  "failedRows": 0,
  "insertedDate": "example_insertedDate",
  "updatedDate": "example_updatedDate"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key