list_category_groups

Generated

Generated from the code by python -m docsgen; a test fails when it no longer matches.

What it does

List the category groups a new category can be created in.

Hidden, deleted and system groups are left out. Pass a group id to create_category.

Behaviour

Kind	read-only
Confirmation	no
Undo	no
Idempotent	yes
YNAB requests	1 for the example below, on a cold cache

Parameters

Name	Type	Required	Default	Description
plan_id	string	yes	—	YNAB plan id or ‘last-used’.

Returns

array of object

Field	Type	Description
id	string	YNAB id of the group, to pass as category_group_id.
name	string	Group name.

Example

Arguments:

{
  "plan_id": "demo-budget"
}

Answer on the demo budget:

[
  {
    "id": "grp-bills",
    "name": "Bills"
  },
  {
    "id": "grp-everyday",
    "name": "Everyday"
  },
  {
    "id": "grp-fun",
    "name": "Fun"
  },
  {
    "id": "grp-savings-goals",
    "name": "Savings goals"
  }
]

Errors

This tool raises no error of its own; YNAB’s errors come back as Error calling tool '<tool>': YNAB <status>: <detail>.