---
title: "Get overview"
method: POST
path: "/v1/tools/betteroff_get_overview"
tags: ["tools"]
---

# Get overview

`POST /v1/tools/betteroff_get_overview`

## Request

- Base URL: `https://api.betteroff.finance`
- URL: `https://api.betteroff.finance/v1/tools/betteroff_get_overview`
- Auth: one of:
  - OpenID Connect (`https://app.betteroff.finance/api/auth/.well-known/openid-configuration`, scopes: `accounts:read`, `networth:read`)
  - HTTP bearer

Use this when the user asks for a household financial overview or data coverage. Get a compact household picture: latest stored valuation, account coverage, canonical ledger review counts, and the masked login and household name. No provider refresh.

## Request body

- object

## Response `200`

Tool result

- union
  - object
    - `ok` false, required
    - `requestId` string
    - `error` string, required
    - `code` string, required
    - `retryable` boolean, required
    - `nextStep` string, required
    - `field` string
    - `missingInputs` object[]
      - `id` string, required
      - `name` string, required
      - `balanceMissing` boolean, required
      - `interestRateMissing` boolean, required
      - `minimumPaymentMissing` boolean, required
  - object
    - `ok` true, required
    - `requestId` string
    - `schemaVersion` '4', required
    - `data` object, required
      - `identity` object, required
        - `login` string, nullable, required
        - `name` string, nullable, required
        - `household` string, nullable, required
      - `valuation` object, nullable, required
        - `id` string, uuid, required
        - `date` string, required
        - `netWorth` string, required: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
        - `totalAssets` string, required: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
        - `totalLiabilities` string, required: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
        - `baseCurrency` string, required
        - `methodologyVersion` string, required
        - `reconciliationStatus` 'reconciled' | 'incomplete' | 'discrepancy', required
        - `accountCount` integer, nullable, required
      - `coverage` object, required
        - `accountCount` integer, required
        - `unknownBalanceCount` integer, required
        - `unknownFreshnessCount` integer, required
      - `ledger` object, nullable, required
        - `engineVersion` string, required
        - `publishedAt` string, date-time, required
        - `reviewItemCount` integer, required
        - `reviewCauses` string[], required
        - `transactionsWithoutEvidence` integer, required
        - `reconciliationBreakCount` integer, nullable, required
        - `latestRunFailed` boolean, required
    - `currency` string, nullable, required
    - `timezone` string, required
    - `asOf` string, nullable, required
    - `revision` integer, required
    - `householdRevision` integer, required
    - `quality` object, required
      - `state` 'complete' | 'partial' | 'unavailable', required
      - `reasons` string[], required
    - `evidence` object[], required
      - `source` string, required
      - `id` string
      - `observedAt` string, nullable, required
    - `page` object, required
      - `returnedCount` integer, required
      - `totalCount` integer, nullable, required
      - `truncated` boolean, required
      - `nextCursor` Schema0, required (unresolved $ref)
    - `warnings` string[], required
    - `notes` string

## Other responses

- `400`: INVALID_INPUT (a missing, unknown, or invalid argument, named in `fields`), TOOL_CALL_REJECTED, or a body that is not JSON.
- `401`: AGENT_TOKEN_INVALID: the token is missing, expired, or revoked.
- `402`: AGENT_SUBSCRIPTION_INACTIVE or FEATURE_NOT_INCLUDED: needs BetterOff Core.
- `403`: INSUFFICIENT_SCOPE, ACCESS_DENIED, or AGENT_GRANT_REVOKED.
- `404`: TOOL_NOT_FOUND, or NOT_FOUND for a record the org does not have.
- `409`: CONFLICT: the record's state rules this call out. Read it again.
- `422`: INCOMPLETE_DATA or RESULT_TOO_LARGE. Narrow the request; don't retry as is.
- `429`: RATE_LIMITED. Retry after Retry-After seconds.
- `503`: DATA_UNAVAILABLE, DEPENDENCY_UNAVAILABLE (including the 25-second tool deadline), or AGENT_AUTHZ_UNAVAILABLE. Retryable.
- `default`: Problem details

---

[API](https://skmtc.dev/betteroff/apis/betteroff-api.md) · [All operations](https://skmtc.dev/betteroff/apis/betteroff-api/llms.txt) · [OpenAPI document](https://skmtc.dev/betteroff/apis/betteroff-api/revisions/bc858c8d428d?raw)