Skip to main content
Retrieve your people watchlists with detailed information about tracked profiles.

​
Query Parameters

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

{
  "watchlists": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "name": "Tech Leaders",
      "slug": "tech-leaders-770e8400",
      "type": "people",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "count": 1
}

​
Response Fields

​
watchlists
array
Array of watchlist objects (when fetching all)
​
count
number
Total number of watchlists (when fetching all)
​
id
string
Unique identifier for the watchlist
​
name
string
Watchlist name
​
slug
string
URL-friendly slug
​
type
string
Always “people” for people watchlists
​
profiles_count
number
Number of tracked profiles

​
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 people watchlists? To get all people watchlists, call GET /api-people-watchlist without any parameters. To get a specific watchlist, pass the watchlist ID as a query parameter: GET /api-people-watchlist?id=YOUR_WATCHLIST_ID. The single-watchlist response includes additional details like profiles_count and associated lists.
Q: What fields are returned in the response? When fetching all watchlists, you get a summary array with id, name, slug, type, and createdAt for each watchlist, plus a total count. When fetching a single watchlist by ID, you also get profiles_count (number of tracked profiles) and the lists array with associated list details.