---
title: "List groups"
method: GET
path: "/{workspace}/groups"
---

# List groups

`GET /{workspace}/groups`

## Request

- Base URL: `https://modeanalytics.com/api`
- URL: `https://modeanalytics.com/api/{workspace}/groups`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/thoughtspot/apis/mode/docs/:workspace/groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Get all `Group`s for a `Workspace`

## Path parameters

- `workspace` string, required

## Response `200`

`UserGroup` collection response

- UserGroups
  - `pagination` Pagination
    - `first_page` string, required
    - `last_page` string, required
    - `total_pages` integer, required
    - `total_count` integer, required
  - `_links` UserGroupsLinks, required
    - `next_page` Link
      - `href` string, required
      - `templated` boolean
    - `prev_page` Link
      - `href` string, required
      - `templated` boolean
    - `self` Link, required
      - `href` string, required
      - `templated` boolean
  - `_embedded` unknown

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: `Membership` not found for `Workspace`

---

[API](https://skmtc.dev/thoughtspot/apis/mode.md) - [All operations](https://skmtc.dev/thoughtspot/apis/mode/llms.txt) - [OpenAPI document](https://skmtc.dev/thoughtspot/apis/mode/revisions/4c694c3fdeb1?raw)