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