{
  "data": {
    "user": {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "email": "user@example.com",
      "name": null,
      "image": null,
      "role": "string",
      "emailVerified": false,
      "twoFactorEnabled": false,
      "softphone_layout": "compact_bottom_bar",
      "voicemail_to_email_enabled": false,
      "voicemail_to_email_address": null,
      "inbox_signature": null,
      "inbox_show_archived_tags": false
    },
    "tenant": {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "name": "string",
      "slug": "string",
      "plan": "string",
      "logoUrl": null
    },
    "organizations": [
      {
        "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
        "name": "string",
        "slug": "string",
        "logoUrl": null,
        "role": "string"
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "data": {
    "user": {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "email": "user@example.com",
      "name": null,
      "image": null,
      "role": "string",
      "emailVerified": false,
      "twoFactorEnabled": false,
      "softphone_layout": "compact_bottom_bar",
      "voicemail_to_email_enabled": false,
      "voicemail_to_email_address": null,
      "inbox_signature": null,
      "inbox_show_archived_tags": false
    },
    "tenant": {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "name": "string",
      "slug": "string",
      "plan": "string",
      "logoUrl": null
    },
    "organizations": [
      {
        "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
        "name": "string",
        "slug": "string",
        "logoUrl": null,
        "role": "string"
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Account API

The authenticated user’s profile, preferences, and speed-dial favorites Base path: /api/v1/me Endpoint count: 2

title: “Errors worth branching on” description: “Per-endpoint failure templates matching the envelope — what actually fires, what to retry, what to surface to the operator.”

Errors worth branching on

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.

Get the authenticated user

GET /api/v1/me

Returns the authenticated user plus the active tenant and the list of organizations the user belongs to. The mobile client uses this to bootstrap post-login (replaces the legacy EXPO_PUBLIC_ORBIT_TENANT_ID env-var hack). The dashboard uses the same shape for the org-picker + Settings → Profile cards.

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/me" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/me', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/me", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/me", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/me')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/me');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "user": {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "email": "user@example.com",
      "name": null,
      "image": null,
      "role": "string",
      "emailVerified": false,
      "twoFactorEnabled": false,
      "softphone_layout": "compact_bottom_bar",
      "voicemail_to_email_enabled": false,
      "voicemail_to_email_address": null,
      "inbox_signature": null,
      "inbox_show_archived_tags": false
    },
    "tenant": {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "name": "string",
      "slug": "string",
      "plan": "string",
      "logoUrl": null
    },
    "organizations": [
      {
        "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
        "name": "string",
        "slug": "string",
        "logoUrl": null,
        "role": "string"
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Update per-user preferences

PATCH /api/v1/me

Partial update of the authenticated user’s preferences. Only fields supplied in the body are written. Returns the updated subset so the FE can confirm the persisted value without a second GET.

string (enum: true|false)

string | null (enum: compact_bottom_bar|floating_panel|side_panel|null)

Softphone widget layout. NULL resets to the platform default.

boolean

When TRUE every voicemail assigned to this user triggers an audio-attached email via the dispatcher scheduler.

string | null

Alternate routing address. NULL clears to users.email.

string | null

Operator signature block (≤ 2 000 chars). NULL or whitespace-only string clears the persisted value.

boolean

Inbox → Settings → Conversation tags ‘Show archived tags’ view toggle. Persisted so the choice survives reload + multi-device.

cURL

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

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/me', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/me", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/me", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/me')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/me');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "updated": false,
    "user": {
      "softphone_layout": "compact_bottom_bar",
      "voicemail_to_email_enabled": false,
      "voicemail_to_email_address": null,
      "inbox_signature": null,
      "inbox_show_archived_tags": false
    }
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

API Reference

All Endpoints

Account API

Account API

title: “Errors worth branching on” description: “Per-endpoint failure templates matching the envelope — what actually fires, what to retry, what to surface to the operator.”

Errors worth branching on

401 — Unauthorized

403 — Forbidden

422 — Schema

429 — Rate

402 — Feature gate

60-second retry matrix

Get the authenticated user

Update per-user preferences

​Account API

​title: “Errors worth branching on” description: “Per-endpoint failure templates matching the envelope — what actually fires, what to retry, what to surface to the operator.”

​Errors worth branching on

​401 — Unauthorized

​403 — Forbidden

​422 — Schema

​429 — Rate

​402 — Feature gate

​60-second retry matrix

​Get the authenticated user

​Update per-user preferences

Account API

title: “Errors worth branching on” description: “Per-endpoint failure templates matching the envelope — what actually fires, what to retry, what to surface to the operator.”

Errors worth branching on

401 — Unauthorized

403 — Forbidden

422 — Schema

429 — Rate

402 — Feature gate

60-second retry matrix

Get the authenticated user

Update per-user preferences