Skip to main content

Errors

The API uses standard HTTP status codes and returns a consistent error body.

Error Response Format

{
"error": "NOT_FOUND",
"message": "errors.developer_api.patient_not_found"
}
FieldDescription
errorMachine-readable error code
messagei18n translation key

HTTP Status Codes

CodeMeaning
200Success
202Accepted (async operation queued)
400Bad request — malformed body or missing required params
401Unauthorized — invalid or missing credentials
403Forbidden — valid credentials but insufficient scope
404Not found
422Validation error
429Rate limit exceeded
500Internal server error

Common Error Codes

errorHTTPDescription
UNAUTHORIZED401Missing or invalid Authorization header
FORBIDDEN403API key lacks the required scope
NOT_FOUND404Resource does not exist or belongs to another clinic
VALIDATION422Invalid field value (details in message)
INVALID_PARAMS400Missing required query parameters
INTERNAL500Unexpected server error