tools

Get overview

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.

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

Request body

object required

Response

Tool result

OR

Changes

No recorded changes to this operation across all 1 revision of this API.