Lists

Get a list

Get a list with all its items. Accepts EITHER the numeric list id or the list's public identifier (e.g. "fintech-8f3k2"), and what comes back follows which one you used. Numeric id: the owner view — every field, and you must own the list. Public identifier: the published view, readable by anyone once the owner has published it, carrying names, titles, companies, screening scores and the per-criterion breakdown, but never connection paths, introducer identities, contact details or warmth. On a public read, id is null unless you own the list, and item ids are absent. Items are sorted by connection strength (warmth score) on the owner view. Supports cursor pagination via cursor and limit.

get/v2/lists/{id}

Request

  • Base URL: https://api.village.ai
  • URL: https://api.village.ai/v2/lists/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

List ID

Example:123

Query parameters

cursorstring

Opaque cursor for items pagination (from previous response)

Example:eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9
limitstring

Number of items per page (max 100)

Example:20

Response

List retrieved successfully

Example response

{
  "data": {
    "public_id": "fintech-8f3k2"
  },
  "pagination": {
    "cursor": "eyJpZCI6IjEyMzQ1In0",
    "has_next_page": true,
    "count": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.