BizKitHub
DocsAPI ReferenceImport/bff/import/list
getImportAdmin BFF

/bff/import/list

Returns a paginated list of import jobs for the authenticated organisation. Imports are sorted by creation date (newest first). Supports fulltext search on source name via the filterFulltextQuery query parameter.

ImportgetBffImportList

Parameters

3 query

Query parameters

· 3
pagestringOptional

Page number (1-based) for pagination.

Example1
limitstringOptional

Maximum items per page (1-500, default 50).

Example50
filterFulltextQuerystringOptional

Full-text search on source name.

Exampleproducts.csv

Response schema

1 status code documented

200SuccessPaginated list of import jobs.
itemsobject[]Required

Array of import jobs matching the query criteria.

Each array item:

Single import job summary.

idstringRequired

External ID of the import job.

externalIdstringRequired

Unique external identifier of the import job.

providerstringRequired

Import provider ("shoptet" or "manual").

dataTypestringRequired

Type of entity being imported.

sourceTypestringRequired

Source type ("file" or "url").

sourceNamestringRequired

Original filename or URL used as the import source.

statusstringRequired

Current status of the import job.

totalRowsnumberRequired

Total number of rows in the source file.

importedRowsnumberRequired

Number of rows successfully imported so far.

failedRowsnumberRequired

Number of rows that failed to import.

insertedDatestringRequired

ISO timestamp when the import was created.

updatedDatestringRequired

ISO timestamp of the last status update.

itemCountnumberRequired

Total number of import jobs matching the query (before pagination).

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "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"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/import/list

get
curl -X GET "https://api.bizkithub.com/bff/import/list?page=1&limit=50&filterFulltextQuery=products.csv" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key