Skip to main content
GET
/
api
/
v2
/
keywords
List keywords
curl --request GET \
  --url https://app.octolens.com/api/v2/keywords \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 42,
      "keyword": "acme corp",
      "context": "Acme is a cloud storage company, not the cartoon.",
      "additionalTerms": "deployment, preview",
      "additionalTermsAndOr": true,
      "caseSensitive": true,
      "symbolSensitive": true,
      "platforms": [
        "reddit",
        "twitter",
        "youtube"
      ],
      "excludeWords": "jobs, hiring, is-for-sale",
      "wildcardExcludeWords": "<string>",
      "excludeAuthors": "spambot1, crypto_guy",
      "color": "#7c3aed",
      "tag": "own_brand",
      "paused": true,
      "isSubReddit": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://octolens.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Response

200 response

List of keywords for the authenticated organization.

​
data
object[]
required