OverviewAPI Reference
Groups

List groups

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.

GET
/v1/groups

Authorization

AuthorizationBearer <token>

API key minted via POST /v1/api-keys (format mk_live_...)

In: header

Query Parameters

externalId?string

Only the group carrying exactly this externalId.

Length1 <= length <= 128

Response Body

application/json

application/json

curl -X GET "https://api.mentio.dev/v1/groups"
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "externalId": "string",
      "isDefault": true,
      "context": "string",
      "stats": {
        "keywords": 0,
        "active": 0
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}

Get a group GET

Previous Page

Update a group PATCH

Rename a group, change your id for it (`externalId`, null clears) or its company description (`context`, null clears: the workspace profile applies again; new mentions are judged with it at once, old ones are not rescored). The default group can be renamed like any other but takes no description: it is the workspace itself and reads the company profile.