Skip to main content
GET
List keyword suggestions

Authorizations

Authorization
string
header
required

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

Query Parameters

keywordId
integer

Narrow to one keyword. Omit to list org-wide.

Required range: -9007199254740991 <= x <= 9007199254740991
withVolume
enum<string>

Pass the string "true" or "false". When omitted or "true", the org-wide SuggestionsWithVolume shape is returned. When "false", returns the SuggestionCounts per-keyword count summary instead.

Available options:
true,
false
Example:

"false"

cursor
string

Opaque pagination cursor — pass back nextCursor from the previous response. Only applies to the org-wide (SuggestionsWithVolume) shape.

limit
integer

Max suggestions to return per page (1–100). Default 25. Only applies to the org-wide (SuggestionsWithVolume) shape.

Required range: 1 <= x <= 100

Response

200 response

Shape depends on the query: per-keyword list, count summary, or full enriched list with volume.

keyword
object
required

Snapshot of the current keyword config so the UI can show a diff preview.

suggestions
object[]
required

All non-expired suggestions for the requested keyword.