Skip to main content
GET
/
back-office
/
sync
/
historical
/
{connectionId}
Get Sync Status
curl --request GET \
  --url https://api.example.com/back-office/sync/historical/{connectionId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "connectionId": "<string>",
    "jobId": "<string>",
    "status": "cancelled",
    "syncMode": "<string>",
    "startedAt": "<string>",
    "completedAt": "<string>",
    "recordsProcessed": 123,
    "recordsSucceeded": 123,
    "recordsFailed": 123,
    "summary": "<string>",
    "dateRangeStart": "<string>",
    "dateRangeEnd": "<string>",
    "invoiceIds": [
      "<string>"
    ],
    "customerIds": [
      "<string>"
    ],
    "jobType": "sync_customer",
    "duration": 123
  },
  "code": "health_status_ok",
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
connectionId
string
required

Connection ID to check status for

Response

Sync status retrieved successfully

​
data
object
required
​
code
enum<string>
Available options:
health_status_ok,
health_status_error,
validation_error,
bad_request,
unauthorized,
forbidden,
not_found,
method_not_allowed,
internal_server_error,
organization_not_found,
cannot_access_organization,
api_key_not_found,
resource_already_exists
​
message
string