---
title: "Get a list of groups the user is a member of."
method: GET
path: "/v2/console/account/{id}/group"
tags: ["Console"]
---

# Get a list of groups the user is a member of.

`GET /v2/console/account/{id}/group`

## Request

- Base URL: `http://127.0.0.1:7351`
- URL: `http://127.0.0.1:7351/v2/console/account/{id}/group`
- Auth: API key in header `Authorization`

## Path parameters

- `id` string, required

## Response `200`

A successful response.

- UserGroupList: A list of groups belonging to a user, along with the user's role in each group.
  - `user_groups` UserGroup[]: Group-role pairs for a user.
    - `group` Group: A group in the server.
      - `id` string: The id of a group.
      - `creator_id` string: The id of the user who created the group.
      - `name` string: The unique name of the group.
      - `description` string: A description for the group.
      - `lang_tag` string: The language expected to be a tag which follows the BCP-47 spec.
      - `metadata` string: Additional information stored as a JSON object.
      - `avatar_url` string: A URL for an avatar image.
      - `open` boolean: Anyone can join open groups, otherwise only admins can accept members.
      - `edge_count` integer: The current count of all members in the group.
      - `max_count` integer: The maximum number of members allowed.
      - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
      - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
    - `state` integer: The user's relationship to the group.
  - `cursor` string: Cursor for the next page of results, if any.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2.md) - [All operations](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/revisions/fbde2e3c5ead?raw)