API REFERENCE · SCHEMA

Error schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.