List Members

Paginate the members of a list.

Returns a paginated list of a list's members. The shape of each member follows the list kind: company lists return name and logo_url; people lists return first_name / last_name. Every member also carries its tracking_status and signal_bucket. The total is in meta.pagination.

tracking_status and signal_bucket are null for any member that has no override of its own — and null means the member follows the list's default_tracking_status and default_signal_bucket. That is the normal case. Read the list itself with Get list to know what a null resolves to, and use Set member tracking status to give one member a value of its own.

List members

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

Path parameters

ParameterTypeDescription
kindstringList kind: company or profile (matches the list type).
list_idintegerIdentifier of the list. Specific to your environment.

Query parameters

ParameterTypeDescription
pageintegerPage number, starting at 1. Defaults to 1.
page_sizeintegerItems per page. Defaults to 25, max 100.
qstringSearch term. Matches by name, LinkedIn handle, or (for people) current company. Case-insensitive, matches partial text, up to 255 characters.
response_formatenumconcise, normalized (default), or detailed. concise returns id, linkedin_handle and linkedin_url only; normalized and detailed are identical and add the name fields, the images and both overrides.

Example request

curl "https://api.getsillage.com/api/v2/lists/company/128/members?page=1&page_size=25&q=openai" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Example response

The first member below inherits the list defaults; the second has been explicitly unfollowed.

{
  "data": [
    {
      "id": 901,
      "name": "OpenAI",
      "linkedin_handle": "openai",
      "linkedin_url": "https://www.linkedin.com/company/openai",
      "logo_url": "https://media.licdn.com/dms/image/openai-logo.png",
      "tracking_status": null,
      "signal_bucket": null
    },
    {
      "id": 902,
      "name": "Stripe",
      "linkedin_handle": "stripe",
      "linkedin_url": "https://www.linkedin.com/company/stripe",
      "logo_url": null,
      "tracking_status": "unfollowed",
      "signal_bucket": "bucket_2"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "total": 12
    }
  }
}

Example response — a list of people

A member of a profile list carries the person's fields instead, and the company they currently work at.

{
  "data": [
    {
      "id": 5512,
      "first_name": "Jane",
      "last_name": "Doe",
      "linkedin_handle": "jane-doe",
      "linkedin_url": "https://www.linkedin.com/in/jane-doe",
      "avatar_url": "https://media.licdn.com/dms/image/jane-doe.jpg",
      "position": "VP Engineering",
      "linkedin_headline": "VP Engineering at OpenAI",
      "enrichment_status": "enriched",
      "current_company": {
        "name": "OpenAI",
        "logo_url": "https://media.licdn.com/dms/image/openai-logo.png"
      },
      "tracking_status": null,
      "signal_bucket": null
    }
  ],
  "meta": {
    "pagination": { "page": 1, "page_size": 25, "page_count": 1, "total": 1 }
  }
}

Response fields

Every member carries these, whatever the list kind:

FieldTypeDescription
data[].idintegerIdentifier of the member. Pass it to Remove member.
data[].linkedin_handlestringLinkedIn handle, or null when we do not have one.
data[].linkedin_urlstringLinkedIn URL, or null when we do not have one.
data[].tracking_statusstringfollowed, unfollowed, or null when the member follows the list's default_tracking_status.
data[].signal_bucketstringbucket_1, bucket_2, bucket_3, or null when the member follows the list's default_signal_bucket.

On a company list, each member also carries:

FieldTypeDescription
data[].namestringCompany name, or null.
data[].logo_urlstringCompany logo, or null.

On a profile list, each member also carries:

FieldTypeDescription
data[].first_namestringFirst name, or null.
data[].last_namestringLast name, or null.
data[].avatar_urlstringProfile picture, or null.
data[].positionstringCurrent job title, or null.
data[].linkedin_headlinestringThe person's LinkedIn headline, or null.
data[].enrichment_statusstringHow far we have got enriching this person, or null if we have not started.
data[].current_companyobjectThe company they work at now, or null if we do not know it.
data[].current_company.namestringCompany name, or null.
data[].current_company.logo_urlstringCompany logo, or null.

Signal buckets are a label only. They are stored and returned, and change nothing about how a member is processed today.

Errors

StatusDescription
401The API key is missing or invalid.
404The list does not exist in your workspace.
422Invalid list_id or query parameters.
429Too many requests.
500An unexpected server error occurred.

On this page