List Categories
list_categoriesRetrieve all category groups and categories with budgeted, activity, and balance amounts for the current month to locate category IDs and survey budget structure. Flags hidden, deleted, and internal items for filtering.
Instructions
List all category groups and their categories with budgeted/activity/balance amounts (dollars) for the current month. Read-only. Use to find category IDs and survey the budget structure; for a specific month's numbers use get_month, and for name-based lookup use search_categories. Hidden, deleted, and YNAB-internal items (e.g. Credit Card Payments, Internal Master Category) are included with 'hidden' / 'deleted' / 'internal' flags — filter on them when presenting.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| budgetId | No | Budget ID (uses default if not provided) | |
| lastKnowledgeOfServer | No | Delta request server knowledge. When provided, returns { category_groups, server_knowledge }. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |