Skip to main content

​
Standard Envelope

All successful responses are wrapped in a standard envelope: 
{
  "data": { ... },
  "metadata": {
    "request_id": "req_abc123"
  }
}
FieldDescription
dataThe response payload (object or array)
metadata.request_idUnique identifier for the request, useful for debugging

​
Response Keys

All API responses use snake_case for field names: 
{
  "data": {
    "first_name": "John",
    "linkedin_url": "https://linkedin.com/in/johndoe",
    "image_url": "https://..."
  },
  "metadata": {
    "request_id": "req_abc123"
  }
}

​
OpenAPI Specification

The complete API specification is available in OpenAPI 3.0 format: 
https://api.village.do/v2/docs/openapi.json
You can use this specification with:
  • API clients (Postman, Insomnia)
  • Code generators (OpenAPI Generator, swagger-codegen)
  • AI assistants and LLMs for API integration
  • Documentation tools