Response Format

All API responses follow a consistent JSON structure for both success and error cases. This allows for predictable parsing and handling of responses in client applications.

On success, a data object is returned along with a confirmation message.

On error, the response includes an error code, a descriptive message, and an optional errors array for additional context (e.g., validation issues).

Success Response (`200 OK`)

{
  "success": true,
  "message": "Success",
  "data": { ... }
}

Error Response (e.g. `401`, `422`)

{
  "success": false,
  "code": "ERROR_CODE",
  "message": "Brief error description",
  "errors": []
}

Success Response (200 OK)#

Error Response (e.g. 401, 422)#

Success Response (`200 OK`)

Error Response (e.g. `401`, `422`)