Skip to main content

API Conventions

  • Versioning: All endpoints are currently on v1
  • Content-Type: Only application/json is supported
  • Pagination: Use start (offset) and limit (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 success is true, everything worked
  • If success is false, check the message field for error details
  • Use hasMore to determine if you need to paginate