---
title: "List Groups"
method: GET
path: "/api/v1/auth/group"
tags: ["Groups"]
---

# List Groups

`GET /api/v1/auth/group`

Get a list of user groups in the workspace.

## Response `200`

List of groups.

- object
  - `links` object — Indicates Links to associated pages.
    - `next` string — The link to the next page (null if there are no more pages).
    - `previous` string — The link to the previous page (null if on the first page).
  - `meta` object — Reprents the meta data of the response.
    - `page` integer — The current page number.
    - `previous_page` integer — The previous page number (null if on the first page).
    - `next_page` integer — The next page number (null if on the last page).
  - `count` integer — The total count of items returned.
  - `total_pages` integer — The total number of pages.
  - `results` V1UserGroupResponse[]
    - `id` string — The ID of the group.
    - `created_at` string — The creation timestamp of the group.
    - `updated_at` string — The last update timestamp of the group.
    - `users` string[] — List of user IDs of the members in the group.
    - `name` string — The name of the group.
    - `icon` string — The icon associated with the group.
    - `description` string — The description of the group.
    - `workspace_id` string — The ID of the workspace associated with the grop.
    - `snowflake_role` unknown

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

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