API reference
Read a sync run
GET /v1/syncs/{runId}
Returns the current run record owned by the key’s workspace. A successful GET returns 200 for every run state, including in-progress and failed. Inspect state and errorCode; polling HTTP status does not indicate completion.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”The current run record, including in-progress or failed states.
errorCode is conditionally present: required for failed and forbidden in
every other state. The four nullable fields are always present — the gateway
rejects an upstream response that omits them.
Completed, partial and superseded records have non-null timezone and quality.
Completed and superseded quality is reliable (both limitation flags false and
no sampling); partial quality names at least one thresholding, loss or sampling
limitation. A failed record retains null completion/publication fields and a
required classified errorCode.
object
invalid_query — the URL carried a query delimiter, including a bare ?.
object
object
object
unauthorized — missing, unknown, expired or revoked key.
object
object
object
Headers
Section titled “Headers ”forbidden — the key lacks sync:write.
object
object
object
run_not_found — no such run in this workspace.
object
object
object
method_not_allowed — Allow names the method this route accepts.
object
object
object
Headers
Section titled “Headers ”sync_unavailable, auth_unavailable, credential_configuration_unavailable,
invalid_clickhouse_config, or ledger_unavailable.
The sync service builds and validates its dependencies before it reads the run, so configuration or ledger failures can be answered here. Extraction- only failures are not part of this polling operation’s contract.