tools

Get setup status

Use this when the user asks what is left to set up, whether billing is active, or which connections need reconnecting. Get this household's BetterOff setup status: billing state, connected-account coverage, and connections that need the user to reconnect, each with a link. The user completes every step in BetterOff while signed in; this tool cannot start checkout, connect accounts, or change agent access.

post/v1/tools/betteroff_get_setup_status

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_get_setup_status
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: accounts: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.