List groups
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.
Authorization
bearerAuth An API key from POST /v1/api-keys. Keys start with ref_.
In: header
Query Parameters
Filters to the one group whose externalId matches exactly.
1 <= length <= 128Response Body
application/json
application/json
curl -X GET "https://example.com/v1/groups"{ "data": [ { "id": "string", "name": "string", "externalId": "string", "isDefault": true, "context": "string", "stats": { "keywords": 0, "active": 0 }, "createdAt": "string", "updatedAt": "string" } ]}Get a group
Returns one keyword group with its external id and keyword counts.
Update a group
Changes a group's name, your `externalId` for it or its company description in `context`. Null clears externalId. Null clears context too, so the workspace profile applies again. New mentions use the new context right away, and older ones are not scored again. You can rename the default group, but it takes no description, because it is the workspace itself and uses the company profile.