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

# List groups

`GET /v1/groups`

## Request

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

The keyword groups of the workspace, the default group first, then oldest first. A group is how keywords are grouped (a customer, a campaign, a product): a term may be tracked once per group, every keyword belongs to one, and GET /v1/usage/breakdown?by=group says what each group cost. Pass `externalId` to find the group carrying your own id.

## Query parameters

- `externalId` string: Only the group carrying exactly this externalId.

## Response `200`

The groups

- object
  - `data` object[], required: The workspace's groups, the default first, then oldest first.
    - `id` string, required: Group id (grp_...).
    - `name` string, required: The group's name.
    - `externalId` string, nullable, required: Your own id for the group, or null.
    - `isDefault` boolean, required: The workspace's default group, where a keyword lands when no group is named.
    - `context` string, nullable, required: The group's own company description for the classifier, or null for the workspace profile.
    - `stats` object, required: Computed over the group's keywords.
      - `keywords` integer, required: Keywords in the group, muted ones included.
      - `active` integer, required: Keywords in the group that are tracking (not muted).
    - `createdAt` string, required: ISO 8601 timestamp, UTC.
    - `updatedAt` string, required: ISO 8601 timestamp, UTC.

## Other responses

- `401`: Missing or invalid API key

---

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