Get Books Health Check Run
GET/api/ledger/health-check/runs/:id
One run in full: its status, provider reads used, and the four sections. Each section has a headline (SKU and book totals, difference, difference %, band, indicative, and trust beside it), a plain-language message worded as a difference to review, the likely posting method (a2x, synder, webgility, sku, manual, mixed; method_confidence = low when only account names were read), month rows with the part explained as timing and the remainder, and findings. The by-channel section adds channels and account_map; the balance-sheet section adds items (inventory, inventory in transit, vendor deposits).
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
A band of null means the section could not be graded; ungraded_reason says why. indicative is true when the section's trust is below Medium. footer carries the account's footer text only when it is turned on. through is the last day the books were read for (the cut-off of a month-to-date run), and bands the grade thresholds the run was graded with. A partial run carries error.kind (reconnect, rate_limited, provider_error, cancelled, interrupted) and can be resumed.
Authentication: Requires Bearer token + accounting.index permission.
Errors: 404 when the run does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.