OverviewAPI Reference
Keywords

List keywords

Every keyword of the workspace, newest first, with its match stats and poll health.

GET
/v1/keywords

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

application/json

curl -X GET "https://api.mentio.dev/v1/keywords"
{
  "data": [
    {
      "id": "string",
      "term": "string",
      "kind": "brand",
      "muted": true,
      "pausedForBalance": true,
      "platforms": [
        "bluesky"
      ],
      "context": "string",
      "matching": {
        "requiredTerms": [
          "string"
        ],
        "requiredMode": "any",
        "excludedTerms": [
          "string"
        ],
        "excludedAuthors": [
          "string"
        ],
        "caseSensitive": true
      },
      "stats": {
        "mentions": 0,
        "relevant": 0,
        "last7d": 0,
        "lastMentionAt": "string",
        "feedback": {
          "relevant": 0,
          "notRelevant": 0
        }
      },
      "polling": [
        {
          "platform": "bluesky",
          "lastPolledAt": "string",
          "emptyPolls": 0
        }
      ],
      "createdAt": "string"
    }
  ]
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}

Get a keyword GET

Previous Page

Update a keyword PATCH

Mute or unmute it, reclassify it (`kind`), change the platforms it is tracked on, its classifier `context`, or its `matching` rules (each rule field optional; an empty list clears one). Rules apply to new mentions from the next poll; stored mentions are untouched.