tools

Get checklist

Use this when the user asks what to do next, how prepared the household is, or about insurance, estate documents, an emergency fund, retirement accounts, or credit freezes; for an explicit saved tax-review request, use includeTaxReviews to read current scoped results. Get the household's readiness checklist: 0-100 score, 30-day change, and each item's status, evidence, and points. Edits happen in BetterOff. Set includeTaxReviews only for an explicit request to read saved tax reviews; summaries use current saved facts.

post/v1/tools/betteroff_get_checklist

Request

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

Request body

includeTaxReviewsboolean

Response

Tool result

OR

Changes

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