ynab_list_months
Retrieve paginated summaries of budget months, showing total income, spending, and category balances. Use offset and limit to navigate through monthly data.
Instructions
List summary data for all budget months with pagination.
Args:
budget_id (string, optional): Budget UUID. Omit to use the default budget.
limit (int, optional): Max results per page. Default: 50.
offset (int, optional): Zero-based offset for pagination. Default: 0.
response_format (string, optional): "json" or "markdown" (default: "markdown").
Returns: months[], total_count, returned_count, offset, has_more, next_offset, cached, cache_info
Examples:
List recent months: call with no args, months are newest-first
Page 2: set limit=12, offset=12
Errors:
"No default budget set" → run ynab_set_default_budget first
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| budget_id | No | ||
| response_format | No | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cached | No | Indicates if data was served from cache | |
| months | Yes | List of months | |
| offset | Yes | Offset used for this response | |
| has_more | Yes | Whether more items exist beyond this page | |
| usedDelta | No | Indicates if delta merge optimization was applied for budgets | |
| cache_info | No | Human-readable cache status message (e.g., "Cache hit", "Cache miss") | |
| next_offset | No | Offset for next page, if has_more is true | |
| total_count | Yes | Total number of items available | |
| returned_count | Yes | Number of items returned |