Skip to main content
Retrieve your keyword watchlists with detailed information about tracked keywords and filtering rules.

​
Query Parameters

​
id
string
Watchlist ID. If omitted, returns all watchlists for your team.
curl -X GET \
  "https://api.outx.ai/api-keyword-watchlist" \
  -H "x-api-key: YOUR_API_KEY"

{
  "watchlists": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Remote Senior Jobs",
      "slug": "remote-senior-jobs-550e8400",
      "type": "keyword",
      "fetchFreqInHours": 6,
      "keywords": ["hiring", "job opening"],
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "count": 1
}

​
Response Fields (All Watchlists)

​
watchlists
array
Array of watchlist objects
​
count
number
Total number of watchlists

​
Response Fields (Single Watchlist)

​
id
string
Unique identifier for the watchlist
​
name
string
Watchlist name
​
slug
string
URL-friendly slug for the watchlist
​
type
string
Always “keyword” for keyword watchlists
​
keywords
array
Array of tracked keywords
​
fetchFreqInHours
number
Fetch frequency in hours
​
keyword_tracking
array
Detailed tracking configuration for each keyword

​
Error Responses

Status CodeError MessageDescription
401UnauthorizedInvalid or missing API key
403Access deniedTrying to access watchlist from another team
404Watchlist not foundWatchlist ID doesn’t exist

​
Frequently Asked Questions

Q: How do I get a specific watchlist versus all my watchlists? To get all keyword watchlists, call GET /api-keyword-watchlist without any parameters. To get a specific watchlist, pass the watchlist ID as a query parameter: GET /api-keyword-watchlist?id=YOUR_WATCHLIST_ID. The single-watchlist response includes more detail, such as the keyword_tracking array with full filtering rules.
Q: What fields are returned in the response? When fetching all watchlists, you get a summary for each one including id, name, slug, type, fetchFreqInHours, keywords, and createdAt. When fetching a single watchlist by ID, you also get the keyword_tracking array, which contains detailed filtering configuration for each keyword including required_keywords and exclude_keywords.