Errors worth branching on

Worked request and response samples

A copyable read plus the one write the org-profile boot loop depends on (front-loads the organization_id the page-supplied error below gates on). Error envelopes like the template below return ; this pair returns .

Read the org profile

GET /api/v1/account

curl https://api.orbit.devotel.io/api/v1/account \
  -H "X-API-Key: dv_test_sk_YOUR_KEY"

{
  "data": {
    "id": "usr_0192",
    "email": "nadia@acme.example",
    "organization_id": "org_0192",
    "organizations": [
      { "id": "org_0192", "label": "Acme North America" }
    ]
  },
  "meta": {
    "request_id": "req_account_read",
    "timestamp": "2026-09-11T12:00:00Z"
  }
}

Named for the boot loop: the dashboard resolves the org id and org-picker options with one GET on every login. Fix the organization id in-test via organizations rather than hard-coding org_* or using a team slug — the 422 envelope below screens exactly that.

Update preferences

PATCH /api/v1/me (org profile lives here; preference writes share it)

curl -X PATCH https://api.orbit.devotel.io/api/v1/me \
  -H "X-API-Key: dv_test_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "preferences": { "theme": "dark" } }'

{
  "data": { "theme": "dark" },
  "meta": {
    "request_id": "req_account_patch",
    "timestamp": "2026-09-11T12:00:01Z"
  }
}

Writes echo the updated subset so a client can re-apply local state without a second GET.

These five failures cover the org profile read (GET /api/v1/account), hammered by every dashboard boot. Each block below is a full { error, meta } envelope as the API returns it, and the matrix at the bottom answers retry vs surface for the same five classes. For the platform-wide decision table these branches plug into, see the error handling guide.

401 — Unauthorized

  {
    "error": {
      "code": "UNAUTHORIZED",
      "message": "The API key is invalid, expired, or lacks the required scope.",
      "status": 401
    },
    "meta": {
      "request_id": "req_accounta1",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 401 on this page is the bearer key failing before the route ran — it never means the resource is wrong. Rotate the key or re-mint the scoped token; retrying the same request changes nothing.

403 — Forbidden

  {
    "error": {
      "code": "FORBIDDEN",
      "message": "The key is valid but does not have the scope this operation requires.",
      "status": 403
    },
    "meta": {
      "request_id": "req_accounta1f",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 403 means the key authenticated but the operation is gated by scope — check the key’s scopes on the developer page; a 403 is never a data-not-found shape.

422 — Schema

  {
    "error": {
      "code": "VALIDATION_ERROR",
      "message": "The request failed input validation.",
      "status": 422,
      "details": { "field": "organization_id", "value": "org_0192", "expected": "the active organization id, not the team slug" }
    },
    "meta": {
      "request_id": "req_accountb2",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 422 means the payload did not match the request schema — branch on error.details.field and resend with the active organization id instead of blind-retrying the same body.

429 — Rate

  {
    "error": {
      "code": "RATE_LIMITED",
      "message": "Too many requests in the current window.",
      "status": 429,
      "details": { "retry_after": 12 }
    },
    "meta": {
      "request_id": "req_accountc3",
      "timestamp": "2026-09-03T12:00:00Z",
      "docs_url": "https://docs.orbit.devotel.io/errors/RATE_LIMITED"
    }
  }

The Retry-After header and error.details.retry_after are both set on every 429 — resend the SAME request after the lower of the two.

402 — Feature gate

  {
    "error": {
      "code": "ACCOUNT_BILLING_SUSPENDED",
      "message": "This account is billing-suspended; read endpoints continue to work.",
      "status": 402,
      "details": { "grace_ends_at": "2026-09-10T00:00:00Z" }
    },
    "meta": {
      "request_id": "req_accountd4",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

Surface the billing portal — only writes are suspended; data reads remain available.

60-second retry matrix

Class	Meaning	Branch response
401 `UNAUTHORIZED`	the bearer key itself fails	Surface. Rotate the key or re-mint the scoped token; do not retry the same request.
403 `FORBIDDEN`	the key lacks this operation’s scope	Surface. Fix the key’s scope set; a retry with the same key never heals it.
422 `VALIDATION_ERROR`	the payload does not match the schema	Fix, then resend intentionally. Branch on `error.details.field`; a blind retry repeats the same 422.
429 `RATE_LIMITED`	the window quota is exhausted	Retry after `error.details.retry_after` (or the `Retry-After` header) with the same request body.
`ACCOUNT_BILLING_SUSPENDED` (402 feature gate)	Surface the billing portal	Branch on `error.code`. Only writes are suspended; data reads remain available.

API Reference

All Endpoints

Errors worth branching on

Worked request and response samples

Read the org profile

Update preferences