Get List

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

Get list

GET/api/v2/lists/{kind}/{list_id}

Path parameters

Parameter	Type	Description
kind	string	List kind: `company` or `profile` (matches the list type).
list_id	integer	Identifier of the list. Specific to your environment.

Query parameters

Parameter	Type	Description
response_format	enum	`concise`, `normalized` (default), or `detailed`. `concise` returns `id`, `kind`, `type` and `name` only; `normalized` and `detailed` are identical and add `description`, the counts, `tier` and the list defaults.

Example request

curl "https://api.getsillage.com/api/v2/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",
    "tier": null,
    "default_tracking_status": "followed",
    "default_signal_bucket": "bucket_1",
    "member_count": 12,
    "bound_agent_count": 1,
    "archived_at": null,
    "persona_ids": []
  }
}

Response fields

Identical to the object returned by Create list. tier is null unless this is a customer or prospect list that has been given one.

Errors

Status	Description
401	The API key is missing or invalid.
404	The list does not exist in your workspace.
422	Invalid `kind` or `list_id` — `kind` must be `company` or `profile`, `list_id` a positive integer.
429	Too many requests.
500	An unexpected server error occurred.