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

# Get accounts

`GET /accounts`

## Request

- Base URL: `https://sandbox.upvest.co`
- URL: `https://sandbox.upvest.co/accounts`
- Auth: OAuth 2 (client credentials, token URL `https://sandbox.upvest.co/auth/token`, scopes: `accounts:read`, `accounts:admin`)

Returns a paginated list of accounts.

Use the `offset` and `limit` query parameters to page through results; `meta.total_count` gives the total number of matching accounts. Both user and business accounts are returned.

See the Accounts overview ([TOL](https://docs.upvest.co/products/tol/guides/accounts/accounts_overview) / [BYOL](https://docs.upvest.co/products/byol/guides/accounts/accounts_overview) / [Omnibus](https://docs.upvest.co/products/omnibus/guides/accounts/accounts_overview)) for account types and the account hierarchy.

## Query parameters

- `sort` 'created_at' | 'updated_at'
- `order` 'ASC' | 'DESC'
- `offset` integer
- `limit` integer

## Response `200`

OK

- object: Paginated list of accounts. Contains a `data` array of user or business account objects and a `meta` object with offset/limit pagination metadata.
  - `meta` object, required: Offset/limit pagination metadata for a list response. Contains the `offset` and `limit` applied to the request, the `count` of resources returned in this page, and the `total_count` of matching resources.
    - `offset` integer, required: Amount of resource to offset in the response.
    - `limit` integer, required: Total limit of the response.
    - `count` integer, required: Count of the resources returned in the response.
    - `total_count` integer, required: Total count of all the resources.
    - `sort` string: The field that the list is sorted by.
    - `order` 'ASC' | 'DESC': The ordering applied to the list. * ASC — Ascending order. * DESC — Descending order.
  - `data` union[], required: List of accounts matching the query.
    - union
      - object: An account held by a user. Accounts belong to an account group and hold positions in the form of units.
        - `id` string, uuid, required: Universally Unique Identifier (UUID) of the account.
        - `created_at` string, date-time, required: Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `updated_at` string, date-time, required: Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `account_group_id` string, uuid, required: Universally Unique Identifier (UUID) of the account group.
        - `type` 'TRADING' | 'PORTFOLIO', required: Account type. * TRADING - Orders in accounts of this type are created on a specific instrument basis. * PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.
        - `users` object[], required: The users associated with the account, each with their relation type.
          - `id` string, uuid: Unique identifier of the user, as a UUID.
          - `type` 'OWNER' | 'GUARDIAN' | 'CHILD': Relation of the user to the account group. * `OWNER` — The user owns the account group. A `JOINT` account group has exactly 2 `OWNER` users. * `CHILD` — The user is the child in a child account group. * `GUARDIAN` — The user is a guardian of a child account group.
        - `account_number` integer, required: The serial account number of the account in the account group.
        - `name` string, required: The name of the account.
        - `status` 'PENDING_APPROVAL' | 'ACTIVE' | 'CLOSING' | 'CLOSED' | 'LOCKED', required: The status of the account. * `PENDING_APPROVAL` — Account approval is pending — the account is visible through our API but cannot be acted on. * `ACTIVE` — Account is active — full functionality of the Investment API is accessible. * `CLOSING` — Account is closing — only sell orders or the transfer of positions out are permissible before the account is closed. * `CLOSED` — Account is closed with zero balance. * `LOCKED` — Account is locked for all actions.
      - object: An account held by a business. Accounts belong to an account group and hold positions in the form of units.
        - `id` string, uuid, required: Universally Unique Identifier (UUID) of the account.
        - `created_at` string, date-time, required: Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `updated_at` string, date-time, required: Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `account_group_id` string, uuid, required: Universally Unique Identifier (UUID) of the account group.
        - `type` 'TRADING' | 'PORTFOLIO', required: Account type. * TRADING - Orders in accounts of this type are created on a specific instrument basis. * PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.
        - `business_id` string, uuid, required: Unique identifier for the business.
        - `account_number` integer, required: The serial account number of the account in the account group.
        - `name` string, required: The name of the account.
        - `status` 'PENDING_APPROVAL' | 'ACTIVE' | 'CLOSING' | 'CLOSED' | 'LOCKED', required: The status of the account. * `PENDING_APPROVAL` — Account approval is pending — the account is visible through our API but cannot be acted on. * `ACTIVE` — Account is active — full functionality of the Investment API is accessible. * `CLOSING` — Account is closing — only sell orders or the transfer of positions out are permissible before the account is closed. * `CLOSED` — Account is closed with zero balance. * `LOCKED` — Account is locked for all actions.

## Other responses

- `400`: Bad Request. The incoming request had a malformed parameter/object.
- `401`: Unauthorized. The caller has not been authenticated.
- `403`: Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `406`: Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429`: Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500`: Internal Server Error. The service encountered an unexpected error.
- `503`: Service Unavailable. The service handling for this request cannot be reached at this time.
- `504`: Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.dev/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.dev/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc.dev/upvest/apis/upvest-investment-api/revisions/ca69534b631d?raw)