Get batch LMS sync job status
curl --request GET \
--url https://api.finosu.com/webhooks/lms/sync/batch/{jobId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.finosu.com/webhooks/lms/sync/batch/{jobId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.finosu.com/webhooks/lms/sync/batch/{jobId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.finosu.com/webhooks/lms/sync/batch/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.finosu.com/webhooks/lms/sync/batch/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.finosu.com/webhooks/lms/sync/batch/{jobId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finosu.com/webhooks/lms/sync/batch/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"jobId": "<string>",
"status": "<string>",
"totalCustomers": 123,
"processed": 123,
"failed": 123,
"progressPercentage": 123,
"createdAt": "<string>",
"processingStartedAt": "<string>",
"processingCompletedAt": "<string>",
"errorMessage": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}LMS Sync
LMS Batch Sync Status
GET
/
webhooks
/
lms
/
sync
/
batch
/
{jobId}
Get batch LMS sync job status
curl --request GET \
--url https://api.finosu.com/webhooks/lms/sync/batch/{jobId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.finosu.com/webhooks/lms/sync/batch/{jobId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.finosu.com/webhooks/lms/sync/batch/{jobId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.finosu.com/webhooks/lms/sync/batch/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.finosu.com/webhooks/lms/sync/batch/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.finosu.com/webhooks/lms/sync/batch/{jobId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finosu.com/webhooks/lms/sync/batch/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"jobId": "<string>",
"status": "<string>",
"totalCustomers": 123,
"processed": 123,
"failed": 123,
"progressPercentage": 123,
"createdAt": "<string>",
"processingStartedAt": "<string>",
"processingCompletedAt": "<string>",
"errorMessage": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}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
{
"jobId": "550e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"totalCustomers": 3,
"processed": 2,
"failed": 1,
"progressPercentage": 100.0,
"createdAt": "2026-08-03T12:00:00Z",
"processingStartedAt": "2026-08-03T12:00:01Z",
"processingCompletedAt": "2026-08-03T12:00:15Z",
"errorMessage": null
}
Response Fields
| Field | Type | Description |
|---|---|---|
| jobId | string | Unique job identifier |
| status | string | Current status: pending, processing, completed, or failed |
| totalCustomers | integer | Total number of customers in the batch |
| processed | integer | Number of customers successfully synced |
| failed | integer | Number of customers that failed to sync |
| progressPercentage | float | Percentage of customers processed (0.0 to 100.0) |
| createdAt | string | ISO 8601 timestamp when the job was created |
| processingStartedAt | string or null | ISO 8601 timestamp when processing began |
| processingCompletedAt | string or null | ISO 8601 timestamp when processing finished |
| errorMessage | string or null | Error description if the job failed |
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
processedandfailedfor 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
completedorfailed - The
progressPercentagefield provides a quick progress indicator
Error Handling
| Status | Meaning |
|---|---|
| 200 | Job found, status returned |
| 401 | Missing or invalid API key |
| 404 | Job not found (wrong ID or belongs to a different company) |
| 422 | Invalid job ID format (not a valid UUID) |
Authentication
Requires X-API-Key header. The job must belong to the company associated with the API key.Response
Current job progress; inspect status and failure counts.