---
title: "List workspace groups"
method: GET
path: "/v1/workspaces/groups"
---

# List workspace groups

`GET /v1/workspaces/groups`

List all groups in the workspace, including their members and default workspace role.

## Response `200`

Successful response

- object — Base response envelope for all successful API responses.
  - `success` true, required
  - `request_id` string, required
  - `result` object, required — The list of workspace groups.
    - `groups` object[], required — All groups in the workspace.
      - `key` string, required — The unique identifier for the group
      - `name` string, required — The name of the group.
      - `description` string, required — A description of the group.
      - `role` union, required — The default workspace role granted to all members of this group. Null if no default role is set.
        - 'owner' — Workspace owner.
        - 'admin' — Workspace admin.
        - 'analyst' — Workspace analyst.
        - 'member' — Workspace member.
        - 'guest' — Workspace guest
      - `created_at` string, date-time, required — An ISO 8601 date-time string.
      - `member_keys` string[], required — The identifiers of the members of this group.

## Other responses

- `4XX` — Client error. Possible status codes include: 400 (invalid request), 401 (missing or invalid API key), 403 (insufficient permissions), 404 (resource not found), 429 (rate limit exceeded).
- `5XX` — Internal server error.

---

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