List Books Health Check Runs
GET/api/ledger/health-check/runs
Run history, newest first, paginated. Each row carries the run window, status, provider reads used, who ran it and the four section headlines (difference %, band, trust).
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token + accounting.index permission.
Filters: filter[status] (running, completed, partial, failed), filter[provider] (xero, qbo), filter[date_from] / filter[date_to] (m/d/Y, on the run date), filter[search] (digits = run ID exactly; YYYY-MM = runs whose window contains that month; otherwise status contains). filter_groups accepts an advanced filter tree on: id, run_status, run_provider, provider_calls (numeric), from_month, to_month (date), created_at (datetime).
Sorts: id, created_at, from_month, to_month, status, provider, provider_calls (prefix - for descending; default -id).
Pagination: page, per_page (default 10, max 100).
Request
Responses
- 200
- 401
- 403
- 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.
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.