Get Keyword Watchlists

curl -X GET \
  "https://api.outx.ai/api-keyword-watchlist" \
  -H "x-api-key: YOUR_API_KEY"

curl -X GET \
  "https://api.outx.ai/api-keyword-watchlist?id=550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: YOUR_API_KEY"

// Get all watchlists
const response = await fetch("https://api.outx.ai/api-keyword-watchlist", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});

// Get specific watchlist
const watchlistId = "550e8400-e29b-41d4-a716-446655440000";
const specificResponse = await fetch(
  `https://api.outx.ai/api-keyword-watchlist?id=${watchlistId}`,
  {
    headers: { "x-api-key": "YOUR_API_KEY" },
  }
);

import requests

headers = {'x-api-key': 'YOUR_API_KEY'}

# Get all watchlists
response = requests.get(
    'https://api.outx.ai/api-keyword-watchlist',
    headers=headers
)

# Get specific watchlist
watchlist_id = '550e8400-e29b-41d4-a716-446655440000'
specific_response = requests.get(
    f'https://api.outx.ai/api-keyword-watchlist?id={watchlist_id}',
    headers=headers
)

{
  "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
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Remote Senior Jobs",
  "slug": "remote-senior-jobs-550e8400",
  "type": "keyword",
  "keywords": ["hiring", "job opening"],
  "fetchFreqInHours": 6,
  "objective": "Find companies actively hiring senior remote engineers",
  "prompt": null,
  "disabled": false,
  "slack_webhook_url": null,
  "last_synced_at": "2026-07-14T22:10:05Z",
  "labels": [
    { "key": "hiring", "description": "Job postings for senior engineering roles", "default": true },
    { "key": "industry-news", "description": "Hiring-market news and layoffs", "default": false }
  ],
  "keyword_tracking": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "primary_keyword": "hiring",
      "required_keywords": ["remote", "senior", "engineer"],
      "excluded_keywords": ["unpaid", "intern"],
      "include_all_required": true,
      "last_synced_at": "2026-07-14T22:10:05Z"
    }
  ]
}

Retrieve your keyword watchlists with detailed information about tracked keywords and filtering rules.

Platform: LinkedIn. This endpoint lists LinkedIn keyword watchlists only. Reddit watchlists live behind GET /api-reddit-watchlist. To list everything your team tracks, call each type’s GET endpoint. See Choose a watchlist type.

To fetch the actual posts collected by a watchlist, use GET /api-posts with the watchlist’s id as watchlist_id.

Query Parameters

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"

curl -X GET \
  "https://api.outx.ai/api-keyword-watchlist?id=550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: YOUR_API_KEY"

// Get all watchlists
const response = await fetch("https://api.outx.ai/api-keyword-watchlist", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});

// Get specific watchlist
const watchlistId = "550e8400-e29b-41d4-a716-446655440000";
const specificResponse = await fetch(
  `https://api.outx.ai/api-keyword-watchlist?id=${watchlistId}`,
  {
    headers: { "x-api-key": "YOUR_API_KEY" },
  }
);

import requests

headers = {'x-api-key': 'YOUR_API_KEY'}

# Get all watchlists
response = requests.get(
    'https://api.outx.ai/api-keyword-watchlist',
    headers=headers
)

# Get specific watchlist
watchlist_id = '550e8400-e29b-41d4-a716-446655440000'
specific_response = requests.get(
    f'https://api.outx.ai/api-keyword-watchlist?id={watchlist_id}',
    headers=headers
)

{
  "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
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Remote Senior Jobs",
  "slug": "remote-senior-jobs-550e8400",
  "type": "keyword",
  "keywords": ["hiring", "job opening"],
  "fetchFreqInHours": 6,
  "objective": "Find companies actively hiring senior remote engineers",
  "prompt": null,
  "disabled": false,
  "slack_webhook_url": null,
  "last_synced_at": "2026-07-14T22:10:05Z",
  "labels": [
    { "key": "hiring", "description": "Job postings for senior engineering roles", "default": true },
    { "key": "industry-news", "description": "Hiring-market news and layoffs", "default": false }
  ],
  "keyword_tracking": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "primary_keyword": "hiring",
      "required_keywords": ["remote", "senior", "engineer"],
      "excluded_keywords": ["unpaid", "intern"],
      "include_all_required": true,
      "last_synced_at": "2026-07-14T22:10:05Z"
    }
  ]
}

Response Fields (All Watchlists)

array

Array of watchlist objects

number

Total number of watchlists

Response Fields (Single Watchlist)

string

Unique identifier for the watchlist

string

Watchlist name

string

URL-friendly slug for the watchlist

string

Always “keyword” for keyword watchlists

array

Array of tracked keywords

number

Fetch frequency in hours

string | null

One-sentence objective used to score post relevance. null on watchlists created without one (a generated objective may appear a few seconds after create).

string | null

The natural-language prompt the watchlist was generated from, if any.

boolean

Whether the watchlist is paused. A disabled watchlist collects nothing, and PUT requests against it return 409 until it is re-enabled with disable: false.

string | null

Slack webhook the watchlist notifies, if set.

string | null

ISO 8601 timestamp of the last completed fetch cycle. null if the watchlist has never synced.

array

Intent labels on the watchlist, as { key, description, default } objects. Labels with default: true (at most 2) are the watchlist’s default feed filters. Read this before patching labels so you can preserve current defaults. See Intent labels & defaults.

array

Detailed tracking configuration for each keyword: id, primary_keyword, required_keywords, excluded_keywords, include_all_required, last_synced_at. Only on the single-watchlist response.

Error Responses

Status Code	Error Message	Description
401	Unauthorized	Invalid or missing API key
403	Access denied	Trying to access watchlist from another team
404	Watchlist not found or access denied	Watchlist ID doesn’t exist

Frequently Asked Questions

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.

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 excluded_keywords.

Create Update

Getting Started

Authentication (OTP)

Keyword Watchlist

People Watchlist

Company Watchlist

Reddit Watchlist

Posts & Engagement

Team & Usage

LinkedIn Data

Integrations

Get Keyword Watchlists

Query Parameters

Response Fields (All Watchlists)

Response Fields (Single Watchlist)

Error Responses

Frequently Asked Questions

​Query Parameters

​Response Fields (All Watchlists)

​Response Fields (Single Watchlist)

​Error Responses

​Frequently Asked Questions

Query Parameters

Response Fields (All Watchlists)

Response Fields (Single Watchlist)

Error Responses

Frequently Asked Questions