GET
/
lists
Get Lists
curl --request GET \
  --url https://api.village.do/v1/lists \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "lists": [
      {
        "id": 42,
        "title": "Seed investors",
        "type": "people",
        "fit_count": 0
      },
      {
        "id": 43,
        "title": "AI founders",
        "type": "people",
        "fit_count": 18
      }
    ],
    "pagination": {
      "total": 2,
      "page": 1,
      "limit": 20,
      "hasNextPage": false
    }
  }
}

Authorizations

​
x-access-token
string
header
required

JWT token obtained from /users/authorization endpoint

Headers

​
user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village. Not needed when using user token authentication.

Query Parameters

​
name
string
​
type
enum<string>
Available options:
people,
company
​
page
integer
default:1
​
limit
integer
default:20

Response

200
application/json

Lists page

The response is of type object.