Get bulk import job status

Retrieve the current status and results of a bulk customer import job. This endpoint can be used to track the progress of both CSV uploads.

The response includes:

• Overall job status
• Progress statistics
• Detailed error information for failed entries
• Completion timestamp when finished

GET /customers/bulk/jobs/{jobId}

JavaScript

JavaScript

import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

const response = await client.customers.bulk.getJobStatus('jobId');

console.log(response.jobId);

200

{
  "jobId": "Job:019542f5-b3e7-1d02-0000-000000000006",
  "status": "PROCESSING",
  "progress": {
    "total": 5000,
    "processed": 2500,
    "successful": 2450,
    "failed": 50
  },
  "errors": [
    {
      "correlationId": "biz456",
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "completedAt": "2025-08-15T14:32:00Z"
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Path Parameters

jobId · string · required

ID of the bulk import job to retrieve

Response

200

application/json

Job status retrieved successfully

jobId · string · required

Unique identifier for the bulk import job

Example:

"Job:019542f5-b3e7-1d02-0000-000000000006"

status · enum<string> · required

Current status of the job

Available options: PENDING, PROCESSING, COMPLETED, FAILED

Example:

"PROCESSING"

progress · object · required

Show child attributes

errors · GridError · object[]

Detailed error information for failed entries

Show child attributes

completedAt · string<date-time>

Timestamp when the job completed (only present for COMPLETED or FAILED status)

Example:

"2025-08-15T14:32:00Z"