List lists

Returns the lists of your workspace, a page at a time, most recent first. Archived lists are left out unless you send include_archived=true. Deleted lists never appear.

Access modes

Use a workspace API key. The workspace is inferred from the key.

Authorization: Bearer sk_live_...

Query parameters

Parameter	Type	Description
page	integer	Page number, starting at 1. Defaults to 1.
page_size	integer	Items per page. Defaults to 25, maximum 100.
type	string	Only return lists of this type: `competitor`, `partner`, `customer`, `prospect`, `influencer`, `champion` or `employee`.
include_archived	boolean	`true` returns archived lists alongside the active ones. Defaults to `false`.
persona_id	integer	Returns the lists attached to this persona plus every list attached to no persona. Leave it out to get every list.
response_format	string	`concise` or `normalized` (default). `concise` returns `id`, `kind`, `type` and `name` only; `normalized` adds the other fields. With `concise`, the other fields are absent, not `null`.

Example request

curl "https://api.getsillage.com/api/v3/lists?page=1&page_size=25&type=customer" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Success response

Status: 200 OK

{
  "data": [
    {
      "id": 12,
      "kind": "company",
      "type": "customer",
      "name": "Key customers",
      "description": "The accounts we want to keep watching",
      "member_count": 48,
      "bound_signal_setup_count": 0,
      "tier": null,
      "signal_buckets": ["essential"],
      "monitoring_by_persona": [
        { "persona_id": 7, "monitored_count": 48, "not_covered_count": 0 }
      ],
      "mode": "manual",
      "archived": false,
      "archived_at": null,
      "persona_ids": [7],
      "is_deletable": true,
      "not_deletable_reason": null
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "total": 1
    }
  }
}

Response fields

Field	Type	Description
data	array of object	The lists of the page, most recent first. Each item has the fields described in Get a list.
meta.pagination	object	Pagination metadata: `page`, `page_size`, `page_count` and `total`. See Pagination.

Errors

Status	Meaning
401	The API key is missing or invalid.
422	A query parameter is not valid or not known, for example `include_archived` other than `true` or `false`, an unknown `type`, an unknown `response_format` or a `persona_id` that is not one of your personas.
429	Rate limit exceeded.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank; code tells one problem from another, detail says what went wrong this time, and errors names the field at fault.