list_plans

Généré

Généré depuis le code par python -m docsgen ; un test échoue s’il ne correspond plus. Les descriptions viennent du code et restent en anglais : c’est la langue dans laquelle les agents les lisent.

Rôle

List all YNAB plans accessible with the current API key.

A plan is what YNAB now calls a budget, and what users may still call their budget. Use the plan id in subsequent tool calls. ‘last-used’ also works, but names whichever plan was last opened in YNAB: with several plans, pass the id.

Comportement

Nature	lecture seule
Confirmation	non
Annulation	non
Idempotent	oui
Requêtes YNAB	1 pour l’exemple ci-dessous, cache vide

Paramètres

aucun.

Retour

array of object

Champ	Type	Description
id	string	YNAB id of the budget, to pass as plan_id.
name	string	Budget name.
first_month	string | null	First month with data, YYYY-MM-01; null for an empty budget.
last_month	string | null	Last month with data, YYYY-MM-01; null for an empty budget.

Exemple

Arguments :

{}

Réponse sur le budget de démonstration :

[
  {
    "id": "demo-budget",
    "name": "Demo household",
    "first_month": "2026-06-01",
    "last_month": "2026-09-01"
  }
]

Erreurs

Cet outil ne lève pas d’erreur propre ; les erreurs de YNAB reviennent sous la forme Error calling tool '<tool>': YNAB <status>: <detail>.