---
title: "List (and optionally filter) groups."
method: GET
path: "/v2/console/group"
tags: ["Console"]
---

# List (and optionally filter) groups.

`GET /v2/console/group`

## Request

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

## Query parameters

- `filter` string
- `cursor` string

## Response `200`

A successful response.

- ConsoleGroupList: A list of groups.
  - `groups` Group[]: A list of groups.
    - `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.
  - `total_count` integer: Approximate total number of groups.
  - `next_cursor` string: Next cursor.

## 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)