Watchlists

List watchlists

List watchlists owned by the organization associated with the API key, as well as publicly visible watchlists. Supports filtering by name.

get/v1/api/watchlists

Request

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

Query parameters

namestring

Filter watchlists by name (case-insensitive, partial match)

sortBy'id' | 'createdAt' | 'updatedAt' | 'name' required
pageinteger

Zero-based page number to retrieve. Defaults to 0.

sizeinteger

Number of results per page. Must be between 1 and 100; defaults to 10.

sortOrder'asc' | 'desc' required

Required direction used to sort results. Accepts asc or desc.

nulls'first' | 'last'

Placement of null values in sorted results. Accepts first or last.

Response

200 - Success

totalinteger required

Total number of matching watchlists across all pages.

Example response

{
  "total": 1,
  "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": [],
      "companies": [],
      "organizationId": 1001,
      "visible": true
    }
  ]
}

Changes

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