Welcome
Welcome to Village’s API V2 documentation. This is a preview version of our next-generation API with improved endpoints and additional features.
This API version is in preview. Some endpoints may change before the stable release.
Authentication
All API endpoints require an API key for authentication. To get your API key:
-
Log in to the Village Platform Admin
-
Navigate to API Keys
-
Create a new API key or copy your existing one
Include your API key in all requests using the following header:
User Identification
Most endpoints require a user identifier to specify which end-user’s network we’re referencing. This identifier should match the one you used when integrating the user with Village. Include it in the request headers:
user-identifier: YOUR_USER_IDENTIFIER
Base URL
The V2 API is available at:
Rate Limits
-
100 requests per second per API key
-
Contact support to increase limits
Error Responses
All endpoints may return these error responses:
| Status | Description |
|---|
| 400 | Bad Request - Check the request parameters |
| 401 | Unauthorized - Invalid API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource doesn’t exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Please contact support |
