List keywords

GET/api/v1/keywords

Every live keyword on your Alerts plan, in dashboard order. Soft-deleted keywords are not returned.

Request

This endpoint does not require any path, query, or body parameters.

Response

Returns a JSON object with a data field containing the result.

Response fields

data[].idstring

Keyword id. Used by keyword_id filters everywhere else.

data[].textstring

The tracked term.

data[].modestring

exact, proximity or broad.

data[].activeboolean

Paused keywords stay in the list but do not match.

data[].track_postsboolean

Match new posts.

data[].track_commentsboolean

Match new comments.

countnumber

Number of keywords returned.

keyword_limitnumber

Your plan's limit on active keywords.

curl -H "Authorization: Bearer rsp_your_key" \
https://redship.io/api/v1/keywords

Success response200

{
"data": [
  {
    "id": "5b2c7d1e-…",
    "text": "notion alternative",
    "mode": "proximity",
    "active": true,
    "track_posts": true,
    "track_comments": true,
    "created_at": "2026-08-26T09:00:00+00:00",
    "updated_at": "2026-08-26T09:00:00+00:00"
  }
],
"count": 1,
"keyword_limit": 10
}