Get Watchlist
Read a single watchlist by id.
Returns a single watchlist by its numeric id, scoped to your workspace. Returns 404 when the list does not exist in your workspace.
Get watchlist
GET/api/v2/watchlists/{kind}/{watchlist_id}
Path parameters
| Parameter | Type | Description |
|---|---|---|
| kind | string | Watchlist kind: company or profile (matches the list type). |
| watchlist_id | integer | Identifier of the watchlist. |
Query parameters
| Parameter | Type | Description |
|---|---|---|
| response_format | enum | concise, normalized (default), or detailed. concise omits description and counts. |
Example request
curl "https://api.getsillage.com/api/v2/watchlists/company/128" \
-H "Authorization: Bearer $SILLAGE_API_KEY"const response = await fetch('https://api.getsillage.com/api/v2/watchlists/company/128', {
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/company/128'),
{ 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/company/128",
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
}
}Errors
| Status | Description |
|---|---|
| 401 | The API key is missing or invalid. |
| 404 | The watchlist does not exist in your workspace. |
| 422 | Invalid watchlist_id — must be a positive integer. |
| 429 | Too many requests. |