Skip to main content

ErrorResponse

Detailed error information

codestring

Error code

Example: ERR-142
messagestring

Human-readable error message

Example: Resource not found
details object[]

List of error details

  • Array [
  • codestring

    Specific error code

    Example: ER4001
    messagestring

    What went wrong

    Example: Invalid input
    targetstring

    Field that caused the issue

    Example: username
  • ]
  • suggestionsstring[]

    Suggested fixes

    Example: ["Check the resource ID","Ensure the resource exists"]
    metaData object

    Extra metadata to help debugging

    property name*string
    ErrorResponse
    {
    "code": "ERR-142",
    "message": "Resource not found",
    "details": [
    {
    "code": "ER4001",
    "message": "Invalid input",
    "target": "username"
    },
    {
    "code": "ER4002",
    "message": "Missing field",
    "target": "email"
    }
    ],
    "suggestions": [
    "Check the resource ID",
    "Ensure the resource exists"
    ],
    "metaData": {}
    }