Problem Details

noun

say it: “PROB-lum DEE-taylz” /ˈprɒbləm ˈdiːteɪlz/

A standard JSON shape for API error responses, with fields such as type, title, status and detail.

What is Problem Details?

Problem Details (RFC 9457) is a standard JSON shape for errors: type, title, status, detail, plus extra fields like validation errors.

{
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": { "email": ["Enter a valid email address."] }
}

In a sentence

  • “Every error our API returns follows Problem Details, so clients read them the same way.”

Level: Journeyman · More REST API terms at this level

Updated