Skip to main content
GET
/
v2
/
lists
/
{id}
Get a list
curl --request GET \
  --url https://api.village.do/v2/lists/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": 123,
    "title": "<string>",
    "type": "people",
    "description": "<string>",
    "item_count": 123,
    "created_at": "<string>",
    "updated_at": "<string>",
    "items": {
      "data": [
        {
          "id": 123,
          "graph_id": "<string>",
          "type": "people",
          "data": {},
          "created_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

Path Parameters

id
string
required

List ID

Minimum string length: 1
Example:

"123"

Query Parameters

page
string

Page number for items pagination (1-based)

Example:

"1"

limit
string

Number of items per page (max 100)

Example:

"20"

Response

List retrieved successfully

data
object
required

List with paginated items

metadata
object
required