Skip to main content
GET
/
v2
/
lists
List all lists
curl --request GET \
  --url https://api.village.do/v2/lists \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "lists": [
      {
        "id": 123,
        "title": "<string>",
        "type": "people",
        "description": "<string>",
        "item_count": 123,
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "pagination": {
      "page": 123,
      "limit": 123,
      "total": 123,
      "has_next_page": true
    }
  },
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Use the API token from your personal Village account: https://village.do/settings#api-keys

For verified apps accessing user data, create a user token: https://docs.village.do/api-reference-v2/authentication/create-authorization

Query Parameters

page
string

Page number (1-based)

Example:

"1"

limit
string

Number of lists per page (max 100)

Example:

"20"

type
enum<string>

Filter lists by type

Available options:
people,
company
Example:

"people"

Search lists by title

Example:

"Sales leads"

Response

Lists retrieved successfully

data
object
required

Response containing paginated list of user lists

metadata
object
required