We use Google Analytics and a Meta advertising pixel on our public site only — never on the clinical application. You can opt out at any time via “Cookie settings” in the footer. See our privacy policy.

CardioBridge API

Errors

CardioBridge uses conventional HTTP status codes to indicate the success or failure of a request. Error responses include a JSON body with a machine-readable code and a human-readable error message.

Error catalog

StatusCodeWhen it happensHow to handle
400validation_errorA required field is missing or a value failed validation.Inspect the error message, fix the request body, and resubmit.
401missing_api_keyNo x-api-key header was provided.Add the x-api-key header to every request.
401invalid_api_keyThe API key is unknown or has been revoked.Generate a new key in the app under Integrations and update your config.
404not_foundThe referenced intake or job does not exist.Verify the reference; it may belong to another organisation or have been mistyped.
500server_errorSomething went wrong on our end.Retry with exponential backoff; if it persists, contact support.
Retrying
Treat 5xx responses as transient: retry with exponential backoff (e.g. 1s, 2s, 4s, 8s) and a capped number of attempts. Do not retry 4xx errors — fix the request first.
Error response
{
  "error": "invalid or revoked API key"
}