API Conventions
- Versioning: All endpoints are currently on v1
- Content-Type: Only
application/jsonis supported - Pagination: Use
start(offset) andlimit(page size) query parameters where supported
Standard Response Format
Every API response follows this structure:
{
"success": true, // Did the request succeed?
"message": null // Error message (if success is false)
"data": {}, // Your actual data goes here
"total": 0, // Total number of matching records
"hasMore": false, // Are there more records to fetch?
}
What this means:
- If
successistrue, everything worked - If
successisfalse, check themessagefield for error details - Use
hasMoreto determine if you need to paginate