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.
v2DeprecatedLists

Get List

Read a single list by id.

Returns a single list by its numeric id, scoped to your workspace. Returns 404 when the list does not exist in your workspace.

Get list

GET/api/v2/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}

Path parameters

ParameterTypeDescription
partner_workspace_idstringOpaque workspace identifier from the partner system.
kindstringList kind: company or profile (matches the list type).
list_idintegerIdentifier of the list.

Query parameters

ParameterTypeDescription
response_formatenumconcise, normalized (default), or detailed. concise omits description and counts.

Example request

curl "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/lists/company/128" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Example response

{
  "data": {
    "id": 128,
    "kind": "company",
    "type": "competitor",
    "name": "Key competitors",
    "description": "Companies we track for competitive signals",
    "member_count": 12,
    "bound_agent_count": 1,
    "tier": null,
    "default_tracking_status": "followed",
    "default_signal_bucket": null
  }
}

Errors

StatusDescription
401The API key is missing or invalid.
404The list does not exist in your workspace.
422Invalid list_id — must be a positive integer.
429Too many requests.

On this page