HTTP Responses

Success Responses

All successful responses follow this format:

{
  "status": "success",
  "message": "Request completed successfully.",
  "data": { /* relevant response data */ }
}

Examples:

  • 200 OK - Request processed successfully.
  • 201 Created - Resource created successfully.

Error Responses

Error responses contain meaningful error messages and appropriate HTTP status codes.

{
  "status": "error",
  "message": "Detailed error description",
  "code": "error_code"
}

Examples:

  • 400 Bad Request - Invalid request format.
  • 401 Unauthorized - Authentication failed.
  • 403 Forbidden - Access denied.
  • 404 Not Found - Resource does not exist.
  • 500 Internal Server Error - Unexpected server issue.

On this page