Error Handling - Endole API

Endole API returns all responses as a JSON object containing a status field to indicate whether the request succeeded or failed. Every response also includes standard HTTP status codes.

Success Responses

When a request succeeds, the API returns a 200 OK status code with "status": "success" at the root of the JSON payload:

{
  "status": "success",
  "data": {}
}

Error Responses

When a request fails, the API returns an appropriate HTTP error status code, and the JSON payload includes "status": "error", an error code string, and a descriptive message:

{
  "status": "error",
  "code": "HTTPS_REQUIRED",
  "message": "This API requires a secure HTTPS connection."
}

HTTP Status Codes

Code	Status	Description
2xx	Success	The request was successful and processed properly.
4xx	Client Error	The request contains invalid data, missing parameters, or authentication errors.
5xx	Server Error	An unexpected error occurred on Endole’s servers. If this issue persists, please contact support.