---
title: "List accounts"
method: GET
path: "/accounts"
tags: ["Accounts"]
---

# List accounts

`GET /accounts`

Retrieve a paginated list of all accounts for the currently
authenticated user. The returned list is paginated and can be scrolled
by following the `prev` and `next` links where present.

## Query parameters

- `page[size]` integer
- `filter[accountType]` 'SAVER' | 'TRANSACTIONAL' | 'HOME_LOAN' — Specifies the type of bank account. Currently returned values are `SAVER`, `TRANSACTIONAL` and `HOME_LOAN`.
- `filter[ownershipType]` 'INDIVIDUAL' | 'JOINT' — Specifies the structure under which a bank account is owned. Currently returned values are `INDIVIDUAL` and `JOINT`.

## Response `200`

Successful Response

- ListAccountsResponse — Successful response to get all accounts. This returns a paginated list of accounts, which can be scrolled by following the `prev` and `next` links if present.
  - `data` AccountResource[], required — The list of accounts returned in this response.
    - `type` string, required — The type of this resource: `accounts`
    - `id` string, required — The unique identifier for this account.
    - `attributes` object, required
      - `displayName` string, required — The name associated with the account in the Up application.
      - `accountType` 'SAVER' | 'TRANSACTIONAL' | 'HOME_LOAN', required — Specifies the type of bank account. Currently returned values are `SAVER`, `TRANSACTIONAL` and `HOME_LOAN`.
      - `ownershipType` 'INDIVIDUAL' | 'JOINT', required — Specifies the structure under which a bank account is owned. Currently returned values are `INDIVIDUAL` and `JOINT`.
      - `balance` MoneyObject, required — Provides information about a value of money.
        - `currencyCode` string, required — The ISO 4217 currency code.
        - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
        - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
      - `createdAt` string, date-time, required — The date-time at which this account was first opened.
    - `relationships` object, required
      - `transactions` object, required
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.
    - `links` object
      - `self` string, required — The canonical link to this resource within the API.
  - `links` object, required
    - `prev` string, nullable, required — The link to the previous page in the results. If this value is `null` there is no previous page.
    - `next` string, nullable, required — The link to the next page in the results. If this value is `null` there is no next page.

## Changes

- **2024-08-05** (v1) `0026d0a1e76c` — 1 warning, 1 info
  - added the new `HOME_LOAN` enum value to the `data/items/attributes/accountType/allOf[#/components/schemas/AccountTypeEnum]/` response property for the response status `200`
  - added the new enum value `HOME_LOAN` to the `query` request parameter `filter[accountType]`
- **2022-01-09** (v1) `aef57e5ad36b` — 3 info
  - added the new optional `query` request parameter `filter[accountType]`
  - added the new optional `query` request parameter `filter[ownershipType]`
  - added the required property `data/items/attributes/ownershipType` to the response with the `200` status
- **2020-07-21** (v1) `2ac77a5de971` — 1 breaking, 2 warning, 1 info
  - removed the required property `data/items/attributes/ownershipType` from the response with the `200` status
  - deleted the `query` request parameter `filter[accountType]`
  - deleted the `query` request parameter `filter[ownershipType]`
  - removed the `HOME_LOAN` enum value from the `data/items/attributes/accountType/allOf[#/components/schemas/AccountTypeEnum]/` response property for the response status `200`

[Change history](https://skmtc.dev/up-banking/apis/up-api/changes/accounts/get.md)

---

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