ynab_list_payees
Read-onlyIdempotent
Retrieve payees from your YNAB budget with pagination controls. Get results in JSON or Markdown to manage transactions efficiently.
Instructions
List all payees for a budget 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: payees[], total_count, returned_count, offset, has_more, next_offset, cached, cache_info
Examples:
List all payees: call with no args
Page 2: set limit=50, offset=50
Errors:
"No default budget set" → run ynab_set_default_budget first
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| budget_id | No | ||
| limit | No | ||
| offset | No | ||
| response_format | No | markdown |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cached | No | Indicates if data was served from cache | |
| cache_info | No | Human-readable cache status message (e.g., "Cache hit", "Cache miss") | |
| usedDelta | No | Indicates if delta merge optimization was applied for budgets | |
| total_count | Yes | Total number of items available | |
| returned_count | Yes | Number of items returned | |
| offset | Yes | Offset used for this response | |
| has_more | Yes | Whether more items exist beyond this page | |
| next_offset | No | Offset for next page, if has_more is true | |
| payees | Yes | List of payees |