List Watchlists

Paginate the watchlists in your workspace.

Returns a paginated list of the watchlists in your workspace, most recent first. Optionally filter by type. The total is in meta.pagination.

List watchlists

GET/api/v2/watchlists

Query parameters

ParameterTypeDescription
pageintegerPage number, starting at 1. Defaults to 1.
page_sizeintegerItems per page. Defaults to 25, max 100.
typeenumOptional filter — one of competitor, partner, customer, influencer, champion.
response_formatenumconcise, normalized (default), or detailed. concise omits description and counts.

Example request

curl "https://api.getsillage.com/api/v2/watchlists?page=1&page_size=25" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"
const response = await fetch(
  'https://api.getsillage.com/api/v2/watchlists?page=1&page_size=25',
  {
    headers: { Authorization: `Bearer ${process.env.SILLAGE_API_KEY}` },
  },
)

const result = await response.json()
import { request } from 'node:https'

const req = request(
  new URL('https://api.getsillage.com/api/v2/watchlists?page=1&page_size=25'),
  { headers: { Authorization: `Bearer ${process.env.SILLAGE_API_KEY}` } },
  (res) => {
    let data = ''
    res.on('data', (chunk) => {
      data += chunk
    })
    res.on('end', () => {
      console.log(JSON.parse(data))
    })
  },
)

req.end()
import os
import requests

response = requests.get(
    "https://api.getsillage.com/api/v2/watchlists",
    params={"page": 1, "page_size": 25},
    headers={"Authorization": f"Bearer {os.environ['SILLAGE_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
result = response.json()

Example response

{
  "data": [
    {
      "id": 128,
      "kind": "company",
      "type": "competitor",
      "title": "Key competitors",
      "description": "Companies we track for competitive signals",
      "entity_count": 12,
      "bound_agent_count": 1
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "total": 1
    }
  }
}

Errors

StatusDescription
401The API key is missing or invalid.
422Invalid query parameters.
429Too many requests.

On this page