tools

List debts

Use this when the user asks what they owe or which debt terms are missing. Get the user's debts (cards and loans): names with last digits, balances with balanceAsOf, APRs, minimum payments, and totals. Use for debt, interest rate, or payoff-priority questions.

post/v1/tools/betteroff_list_debts

Request

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