Error

If at any point an error occurs. the API responds with a body like this:

{
  "success": false,
  "error_code": 1001,
  "error_message": "a short message describing the error"
}

Internal Server Error

  • http status code: 500
{
  "success": false,
  "error_code": 2001,
  "error_message": "Internal Server error"
}

BadRequestError

  • http status code: 400
{
  "success": false,
  "error_code": 3001,
  "error_message": "Bad Request"
}

ResourceNotFoundError

  • http status code: 404
{
  "success": false,
  "error_code": 4004,
  "error_message": "Resource not found"
}