Skip to main content
GET
Get batch LMS sync job status

Overview

Check the processing status of a batch LMS sync job created via LMS Customer Batch Sync.

Path Parameters

  • jobId — The job ID returned by the batch sync endpoint (required). Must be a valid UUID.

Response Format

Response Fields

Status Values

  • pending — Job is queued but background processing has not started yet
  • processing — Job is actively syncing customers. Poll again to see updated progress.
  • completed — All customers have been processed. Check processed and failed for results.
  • failed — The job encountered a fatal error (e.g., could not read batch data) or all customers failed to sync.

Polling Recommendations

  • Poll every 5 seconds while status is processing
  • Stop polling when status is completed or failed
  • The progressPercentage field provides a quick progress indicator

Error Handling

Authentication

Requires X-API-Key header. The job must belong to the company associated with the API key.

Authorizations

X-API-Key
string
header
required

Path Parameters

jobId
string
required

Job UUID returned when the batch was queued.

Response

Current job progress; inspect status and failure counts.

jobId
string
required
status
string
required
totalCustomers
integer
required
processed
integer
required
failed
integer
required
progressPercentage
number
required
createdAt
string
required
processingStartedAt
string | null
processingCompletedAt
string | null
errorMessage
string | null