API Info
Error Responses
Learn more about our standardized error responses.
Overview
In the event that there’s an issue when making a request to our API, we’ll return a standardized error response that describes the nature of the error in detail.
Read more below to get familiar with the error response format.
Our error responses are based on the RFC 7807 format - a widely used standard for HTTP APIs.
Format
{
"status": 404,
"name": "NOT_FOUND",
"title": "NotFoundError",
"detail": "Could not find organization Devault Medical"
}
status
number
requiredNumeric HTTP status code.
name
string
requiredHuman-readable description of the status code.
title
string
requiredThe specific error description - this wont’t change between occurences of the same error.
detail
string
requiredDetails about this error occurrence - this might change between occurences.