---
title: "Create a group"
method: POST
path: "/{workspace}/groups"
---

# Create a group

`POST /{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/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a user `Group` with the provided attributes

## Path parameters

- `workspace` string, required

## Request body

- CreateUserGroupRequestBody
  - `user_group` object, required: The parameters for the created user group
    - `name` string: The name for the new user group

## Response `200`

`UserGroup` response

- UserGroup
  - `token` string, required
  - `group_type` string, required
  - `name` string, required
  - `description` string, required
  - `state` string, required
  - `member_count` string, required
  - `spaces_count` string, required
  - `data_sources_count` string, required
  - `managed` string, required
  - `_links` UserGroupLinks, required
    - `self` Link, required
      - `href` string, required
      - `templated` boolean
    - `web` Link, required
      - `href` string, required
      - `templated` boolean
    - `creator` Link
      - `href` string, required
      - `templated` boolean
    - `group_memberships` Link, required
      - `href` string, required
      - `templated` boolean
    - `membership_by_id` Link, required
      - `href` string, required
      - `templated` boolean
    - `memberships_preview` Link, required
      - `href` string, required
      - `templated` boolean
  - `_embedded` unknown

## Other responses

- `400`: Bad request
- `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)