Skip to main content

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).

Required scope: accounting:read

Grant 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​

OK

Response Headers
    Content-Type