Base URL
All API requests should be made to:API Versioning
The API uses URL versioning. The current version isv1:
Authentication
Most endpoints require authentication via API key. See the Authentication guide for details.Request Format
All request bodies should be JSON with theContent-Type header:
Response Format
All responses are JSON. Successful responses follow this structure:Error Handling
Error responses include an error message and optional details:HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request - Validation error |
| 401 | Unauthorized - Missing or invalid API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 413 | Payload Too Large |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
Rate Limiting
| Mode | Limit |
|---|---|
| Authenticated | 100 requests/minute |
| Public (Contacts only) | 20 requests/minute per IP |
429 response:
Pagination
List endpoints support pagination withpage and limit query parameters: