Watchlists

Create watchlist

Create a new watchlist under the organization associated with the API key. A watchlist can contain up to 100 combined people and companies.

post/v1/api/watchlists

Request

  • Base URL: https://api.perigon.io
  • URL: https://api.perigon.io/v1/api/watchlists
  • Auth: HTTP bearer

Request body

namestring required

Unique name for the watchlist within the organization

displayNamestring nullable

Display name for the watchlist

descriptionstring nullable

Description of the watchlist

visibleboolean nullable

Whether the watchlist is visible in the UI

Response

200 - Success

Example response

{
  "data": {
    "id": 42,
    "createdAt": "2025-06-01T09:00:00.000Z",
    "updatedAt": "2025-08-01T16:30:00.000Z",
    "name": "ai-executives",
    "displayName": "AI Executives",
    "description": "Leadership at major AI companies.",
    "people": [
      {
        "name": "Sam Altman",
        "description": "CEO of OpenAI",
        "wikidataId": "Q7411063",
        "aliases": []
      }
    ],
    "companies": [
      {
        "name": "OpenAI",
        "description": "AI research company",
        "id": "openai",
        "domain": "openai.com",
        "aliases": []
      }
    ],
    "organizationId": 1001,
    "visible": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.