---
title: "List groups"
method: GET
path: "/v1/groups"
tags: ["Groups"]
---

# List groups

`GET /v1/groups`

## Request

- Base URL: `https://api.rumoro.dev`
- URL: `https://api.rumoro.dev/v1/groups`
- Auth: HTTP bearer

Returns the workspace's keyword groups, the default group first and then the oldest. Groups organize keywords, for example by client, campaign or product. Every keyword is in one group, a group can hold a term once, and GET /v1/usage/breakdown?by=group shows each group's cost. `externalId` looks a group up by your own id.

## Query parameters

- `externalId` string: Filters to the one group whose externalId matches exactly.

## Response `200`

The workspace's groups

- object
  - `data` object[], required: Default group first, then the rest, oldest first.
    - `id` string, required: The group's id (grp_...).
    - `name` string, required: Name of the group.
    - `externalId` string, nullable, required: An id from your own system, or null.
    - `isDefault` boolean, required: True for the workspace's default group. New keywords go there when you don't name a group.
    - `context` string, nullable, required: A company description just for this group, which the classifier reads. Null means the workspace profile is used.
    - `stats` object, required: Counted from the group's keywords.
      - `keywords` integer, required: Number of keywords in the group, muted or not.
      - `active` integer, required: Number of unmuted keywords in the group.
    - `createdAt` string, required: UTC time in ISO 8601.
    - `updatedAt` string, required: UTC time in ISO 8601.

## Other responses

- `401`: The API key is missing or not valid

---

[API](https://skmtc.dev/rumoro/apis/rumoro-api.md) · [All operations](https://skmtc.dev/rumoro/apis/rumoro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rumoro/apis/rumoro-api/revisions/9ef63ea894d1?raw)