List payees
list_payeesRetrieve a paginated, name-sorted list of a YNAB plan’s payees, excluding deleted entries, to review the people and businesses money goes to or comes from.
Instructions
List the plan's payees, sorted by name.
Payees are the people and businesses money goes to and comes from. To find a particular payee, find_payee is much faster than paging through this list. Deleted payees are excluded.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of payees to return per page (default: 50) | |
| offset | No | Number of payees to skip for pagination (default: 0) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payees | Yes | List of payees | |
| pagination | Yes | Pagination information |