---
title: "Get user account groups"
method: GET
path: "/users/{user_id}/account_groups"
tags: ["Account Groups"]
---

# Get user account groups

`GET /users/{user_id}/account_groups`

Lists the account groups of a user specified by ID.

## Query parameters

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

## Response `200`

OK

- object
  - `meta` object, required
    - `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 of the response. * ASC - Ascending order * DESC - Descending order
  - `data` object[], required
    - `id` string, uuid, required — Account group unique identifier.
    - `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)
    - `users` object[], required
      - `id` string, uuid — User unique identifier.
      - `type` 'OWNER' | 'CHILD' | 'GUARDIAN' — Relation type * OWNER - Account Group Owner * CHILD - Child Account Group Owner * GUARDIAN - Child Account Group Guardian
    - `status` 'PENDING_APPROVAL' | 'ACTIVE' | 'CLOSING' | 'CLOSED' | 'LOCKED', required — Status of the account group * PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on. * ACTIVE - Account group is active - full functionality of the Investment API is accessible. * CLOSING - Account group is closing. * CLOSED - Account group is closed. * LOCKED - Account group is locked for all actions.
    - `type` 'PERSONAL' | 'LEGAL_ENTITY' | 'FRENCH_PEA' | 'ISA' | 'CHILD', required — Account group type. * PERSONAL - Account group of a person holding assets on their own behalf. * LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users. * FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions. * ISA - Account group of a UK resident holding assets in an individual savings account. * CHILD - Account group of a child user holding assets in a child account.
    - `securities_account_number` string, ^\d{7,12}$, required — Account unique identifier.

## 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.
- `404` — Not Found. The requested resource could not be found.
- `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.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/2c6bc192bc09/schema)