Lists

Get all lists

Get all your saved lists. Use this to see your collections of people or companies. Supports pagination (page, limit), filtering by type (people or company), and searching by title. Each list includes: id, title, type, description, item_count, and timestamps. Set include_summary=true to also get each list’s screening status, criteria and match counts, a preview of its members, and its import state.

get/v2/lists

Request

Base URL: https://api.village.ai
URL: https://api.village.ai/v2/lists
Auth: HTTP bearer

Query parameters

cursorstring

Opaque cursor for pagination (from previous response)

Example:eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9

limitstring

Number of lists per page (max 100)

Example:20

type'people' | 'company'

Filter lists by type

Example:people

searchstring

Search lists by title

Example:Sales leads

include_summary'true' | 'false'

Add a summary object to each list: screening status, criteria and counts, a preview of the most recent members, and import state. Off by default; the default response is unchanged.

Example:true

Response

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