---
title: "Get all plans"
method: GET
path: "/plans"
tags: ["Plans"]
---

# Get all plans

`GET /plans`

Returns plans list with summary information

## Query parameters

- `include_accounts` boolean

## Response `200`

The list of plans

- PlanSummaryResponse
  - `data` object, required
    - `plans` PlanSummary[], required
      - `id` string, uuid, required
      - `name` string, required
      - `last_modified_on` string, date-time — The last time any changes were made to the plan from either a web or mobile client
      - `first_month` string, date — The earliest plan month
      - `last_month` string, date — The latest plan month
      - `date_format` DateFormat, nullable — The date format setting for the plan. In some cases the format will not be available and will be specified as null.
        - `format` string, required
      - `currency_format` CurrencyFormat, nullable — The currency format setting for the plan. In some cases the format will not be available and will be specified as null.
        - `iso_code` string, required
        - `example_format` string, required
        - `decimal_digits` integer, required
        - `decimal_separator` string, required
        - `symbol_first` boolean, required
        - `group_separator` string, required
        - `currency_symbol` string, required
        - `display_symbol` boolean, required
      - `accounts` Account[] — The plan accounts (only included if `include_accounts=true` specified as query parameter)
        - `id` string, uuid, required
        - `name` string, required
        - `type` 'checking' | 'savings' | 'cash' | 'creditCard' | 'lineOfCredit' | 'otherAsset' | 'otherLiability' | 'mortgage' | 'autoLoan' | 'studentLoan' | 'personalLoan' | 'medicalDebt' | 'otherDebt', required — The type of account
        - `on_budget` boolean, required — Whether this account is "on budget" or not
        - `closed` boolean, required — Whether this account is closed or not
        - `note` string, nullable
        - `balance` integer, required — The current available balance of the account in milliunits format
        - `cleared_balance` integer, required — The current cleared balance of the account in milliunits format
        - `uncleared_balance` integer, required — The current uncleared balance of the account in milliunits format
        - `transfer_payee_id` string, uuid, nullable, required — The payee id which should be used when transferring to this account
        - `direct_import_linked` boolean — Whether or not the account is linked to a financial institution for automatic transaction import.
        - `direct_import_in_error` boolean — If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
        - `last_reconciled_at` string, date-time, nullable — A date/time specifying when the account was last reconciled.
        - `debt_original_balance` integer, nullable — This field is deprecated and will always be null.
        - `debt_interest_rates` LoanAccountPeriodicValue, nullable
        - `debt_minimum_payments` LoanAccountPeriodicValue, nullable
        - `debt_escrow_amounts` LoanAccountPeriodicValue, nullable
        - `deleted` boolean, required — Whether or not the account has been deleted. Deleted accounts will only be included in delta requests.
        - `balance_formatted` string — The current available balance of the account formatted in the plan's currency format
        - `balance_currency` number, double — The current available balance of the account as a decimal currency amount
        - `cleared_balance_formatted` string — The current cleared balance of the account formatted in the plan's currency format
        - `cleared_balance_currency` number, double — The current cleared balance of the account as a decimal currency amount
        - `uncleared_balance_formatted` string — The current uncleared balance of the account formatted in the plan's currency format
        - `uncleared_balance_currency` number, double — The current uncleared balance of the account as a decimal currency amount
    - `default_plan` PlanSummary
      - `id` string, uuid, required
      - `name` string, required
      - `last_modified_on` string, date-time — The last time any changes were made to the plan from either a web or mobile client
      - `first_month` string, date — The earliest plan month
      - `last_month` string, date — The latest plan month
      - `date_format` DateFormat, nullable — The date format setting for the plan. In some cases the format will not be available and will be specified as null.
        - `format` string, required
      - `currency_format` CurrencyFormat, nullable — The currency format setting for the plan. In some cases the format will not be available and will be specified as null.
        - `iso_code` string, required
        - `example_format` string, required
        - `decimal_digits` integer, required
        - `decimal_separator` string, required
        - `symbol_first` boolean, required
        - `group_separator` string, required
        - `currency_symbol` string, required
        - `display_symbol` boolean, required
      - `accounts` Account[] — The plan accounts (only included if `include_accounts=true` specified as query parameter)
        - `id` string, uuid, required
        - `name` string, required
        - `type` 'checking' | 'savings' | 'cash' | 'creditCard' | 'lineOfCredit' | 'otherAsset' | 'otherLiability' | 'mortgage' | 'autoLoan' | 'studentLoan' | 'personalLoan' | 'medicalDebt' | 'otherDebt', required — The type of account
        - `on_budget` boolean, required — Whether this account is "on budget" or not
        - `closed` boolean, required — Whether this account is closed or not
        - `note` string, nullable
        - `balance` integer, required — The current available balance of the account in milliunits format
        - `cleared_balance` integer, required — The current cleared balance of the account in milliunits format
        - `uncleared_balance` integer, required — The current uncleared balance of the account in milliunits format
        - `transfer_payee_id` string, uuid, nullable, required — The payee id which should be used when transferring to this account
        - `direct_import_linked` boolean — Whether or not the account is linked to a financial institution for automatic transaction import.
        - `direct_import_in_error` boolean — If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
        - `last_reconciled_at` string, date-time, nullable — A date/time specifying when the account was last reconciled.
        - `debt_original_balance` integer, nullable — This field is deprecated and will always be null.
        - `debt_interest_rates` LoanAccountPeriodicValue, nullable
        - `debt_minimum_payments` LoanAccountPeriodicValue, nullable
        - `debt_escrow_amounts` LoanAccountPeriodicValue, nullable
        - `deleted` boolean, required — Whether or not the account has been deleted. Deleted accounts will only be included in delta requests.
        - `balance_formatted` string — The current available balance of the account formatted in the plan's currency format
        - `balance_currency` number, double — The current available balance of the account as a decimal currency amount
        - `cleared_balance_formatted` string — The current cleared balance of the account formatted in the plan's currency format
        - `cleared_balance_currency` number, double — The current cleared balance of the account as a decimal currency amount
        - `uncleared_balance_formatted` string — The current uncleared balance of the account formatted in the plan's currency format
        - `uncleared_balance_currency` number, double — The current uncleared balance of the account as a decimal currency amount

## Other responses

- `404` — No plans were found

---

[API](https://skmtc.dev/ynab/apis/ynab-api-endpoints.md) · [All operations](https://skmtc.dev/ynab/apis/ynab-api-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ynab/ynab-api-endpoints/revisions/da7a78345b34/schema)