---
title: "Get checklist"
method: POST
path: "/v1/tools/betteroff_get_checklist"
tags: ["tools"]
---

# Get checklist

`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

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.

## Request body

- object
  - `includeTaxReviews` boolean

## 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
      - `savedTaxReviews` object[]
        - `id` string, uuid, required
        - `year` integer, required
        - `strategy` string, required
        - `status` string, required
        - `state` string, required
        - `evaluationVersion` string, required
        - `completion` string, required
        - `followUpRequested` boolean, required
        - `deadline` string, date, nullable, required
        - `calculations` object, required
          - `jurisdiction` 'US federal', required
          - `currency` 'USD', required
          - `hsa` object, nullable, required
            - `missing` string[], required
            - `ruleVersion` string, required
            - `sources` string[], required
            - `scope` string, required
            - `estimate` object, nullable, required
              - …
          - `dependentCare` object, nullable, required
            - `capacity` number, required
            - `ruleVersion` string, required
            - `comparisonRuleVersion` string, required
            - `sources` string[], required
            - `scope` string, required
            - `comparison` object, required
              - …
        - `conflicts` string[], required
        - `nextAction` string, required
        - `missingFacts` string[], required
        - `limitations` string, required
        - `url` string, uri, required
      - `score` integer, required
      - `changeOver30Days` integer, nullable, required
      - `profileAnswers` object, required
      - `householdAnswers` object, required
      - `items` object[], required
        - `id` string, required
        - `label` string, required
        - `section` string, required
        - `status` 'open' | 'due_again' | 'looks_done_confirm' | 'done' | 'not_applicable', required
        - `why` string, required
        - `evidence` string, nullable, required
        - `lostEvidence` string, nullable, required
        - `notApplicableReason` string, nullable, required
        - `addsPoints` number, nullable, required
        - `lastDone` string, date-time, nullable, required
        - `assignedTo` string, nullable, required
        - `link` string, uri, nullable, required
      - `pageUrl` string, uri, 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` Schema2, 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)