Check list membership

Check which lists contain the given entities. Accepts an array of entity IDs and returns a map of entity_id to the lists that contain it. Entities not in any list are omitted from the response. Use entity_id (not the legacy graph_id naming) to reference people or companies.

POST /v2/lists/check-membership

Check list membership

cURL

curl --request POST \
  --url https://api.village.ai/v2/lists/check-membership \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_ids": [
    "uuid-1",
    "uuid-2"
  ],
  "entity_type": "people"
}
'

200

{
  "data": {},
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization · string · header · required

• Personal: Get your API token
• Verified apps: Create a user token
• Testing: use demo_token_global

Body

application/json

Request body for checking list membership of entities

entity_ids · string[] · required

Array of entity IDs (person or company IDs) to check membership for

Required array length: 1 - 1000 elements

Minimum string length: 1

Example:

["uuid-1", "uuid-2"]

entity_type · enum<string> · required

Type of entities being checked

Available options: people, company

Example:

"people"

Response

200

application/json

Membership check completed

data · object · required

Map of entity_id to array of list memberships. Entities not in any list are omitted.

Show child attributes

metadata · object · required

Show child attributes