Startnext API — Error Codes

Every error response carries the same envelope:

{
    "error": "insufficient_scope",
    "error_description": "This endpoint requires the \"orders:read\" scope"
}

Branch on error — it is stable and machine-readable. error_description is meant for humans, may be null, and may change without notice.

Treat the lists below as the codes you may encounter, not as a closed set: new codes can appear when endpoints gain validation. Handle the ones you care about and fall back on the HTTP status for the rest. See also Error Handling in the Developer Guide.

Common codes

Authentication, permissions, validation and rate limiting produce these on any endpoint that can answer with the given status.

Endpoint-specific codes

Only the endpoints listed here return these.

Framework codes (non-conformant)

These values are sent by myty framework code itself (CSRF middleware, request-body parsing, the generic not-found/bad-request helpers). They are listed so this catalog is complete, but they break two promises this API otherwise makes:

1. Not a machine-readable token. The value is prose with spaces, so you cannot branch on it the way the Developer Guide describes for error.
2. No description. They are sent without an error_description; the field is null.

If you receive one of these, branch on the HTTP status instead of the error value.

Error families

Each error response references one of these schemas. The interactive API reference shows the possible codes per response.