Skip to main content
POST
/
v2
/
lists
Create a list
curl --request POST \
  --url https://api.village.do/v2/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Sales Leads Q1",
  "type": "people",
  "description": "Qualified sales leads for Q1 outreach",
  "is_public": false
}
'
{
  "data": {
    "id": 123,
    "title": "<string>",
    "type": "people",
    "description": "<string>",
    "item_count": 123,
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "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

Body

application/json

Request body for creating a new list

title
string
required

List title

Required string length: 1 - 255
Example:

"Sales Leads Q1"

type
enum<string>
default:people

Type of entities in the list

Available options:
people,
company
Example:

"people"

description
string

Optional list description

Maximum string length: 1000
Example:

"Qualified sales leads for Q1 outreach"

is_public
boolean
default:false

Whether the list is publicly accessible

Example:

false

Response

List created successfully

data
object
required

Response after creating a new list

metadata
object
required