API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.
v2DeprecatedWatchlists

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 or by business unit (persona_id). The total is in meta.pagination.

List watchlists

GET/api/v2/partner/workspaces/{partner_workspace_id}/watchlists

Path parameters

ParameterTypeDescription
partner_workspace_idstringOpaque workspace identifier from the partner system.

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.
persona_idintegerOptional. Only return the lists attached to this business unit, plus the lists not attached to any business unit. An unknown persona_id returns 422.
response_formatenumconcise, normalized (default), or detailed. concise omits description and counts.

Example request

curl "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/watchlists?page=1&page_size=25" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

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