POST
/
lists
Create List
curl --request POST \
  --url https://api.village.do/v1/lists \
  --header 'Content-Type: application/json' \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>' \
  --data '{
  "title": "<string>",
  "type": "people",
  "description": "<string>",
  "is_public": false
}'
{
  "success": true,
  "data": {
    "id": 42,
    "title": "Seed investors",
    "type": "people",
    "description": "",
    "is_public": false,
    "fit_count": 0,
    "created_date": "2024-06-26T12:00:00Z"
  }
}

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.

Body

application/json
​
title
string
required
​
type
enum<string>
default:people
Available options:
people,
company
​
description
string
​
is_public
boolean
default:false

Response

List created

​
data
object