GET
/
lists
/
{listId}
curl --request GET \
  --url https://api.village.do/v1/lists/{listId} \
  --header 'secret-key: <api-key>' \
  --header 'user-identifier: <user-identifier>'
{
  "data": {
    "id": 42,
    "title": "Seed investors",
    "type": "people",
    "description": "<string>",
    "is_public": false,
    "fit_count": 18,
    "created_date": "2024-06-26T12:00:00Z"
  }
}

Authorizations

​
secret-key
string
header
required

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.

Path Parameters

​
listId
integer
required

Response

200
application/json

List details

The response is of type object.