API-Referenz

Konto und Abrechnung

Mit einem API-Schlüssel lesen Sie Kontonutzung, Analytics und Schlüssel-Metadaten. Änderungen an der Abrechnung sowie das Erstellen oder Widerrufen von Schlüsseln erfordern eine Dashboard-Sitzung.

GET/account
API-Schlüssel

Konto, Nutzung, Abrechnungsstatus und Workspace-Anzahl mit einem API-Schlüssel abrufen

API-Schlüssel-Pendant zum Dashboard-Profil: Kontoinhaber, Empfänger- und Anhangnutzung im aktuellen Zeitraum im Verhältnis zu den Tariflimits, Zugriffsstufe, Zusammenfassung der Absenderreputation, Abonnementstatus, veröffentlichte Tarife und Workspace-Anzahl. Nur lesend; Änderungen an der Abrechnung bleiben der Sitzung vorbehalten.

Anfrage
curl https://sendhq.cc/api/v1/account \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Antwort 200
{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "infrastructure": {},
  "billing": {},
  "plans": [],
  "workspace": {
    "mailer": "ses",
    "stats": {}
  }
}
GET/account/diagnostics
API-Schlüssel

Diagnose sending and receiving problems in the workspace

Read-only troubleshooting snapshot from stored state: an `issues` list in plain language, plan and usage against limits, each domain's DKIM and inbound state, sending identities, 30-day deliverability and sender reputation, suppressions and unsubscribes, the last 30 days of messages that were not sent with their reasons, bounce, complaint and reject events, and webhook delivery health. Never returns message bodies, API keys or webhook secrets.

Anfrage
curl https://sendhq.cc/api/v1/account/diagnostics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Antwort 200
{
  "generatedAt": "2026-10-30T12:00:00.000Z",
  "windowDays": 30,
  "issues": [
    {
      "severity": "action",
      "code": "domain_unverified",
      "message": "example.com is not verified (pending); 2 of 3 DKIM records are not visible in DNS yet."
    }
  ],
  "plan": {},
  "domains": [],
  "sendingIdentities": {
    "domains": [],
    "addresses": []
  },
  "inbound": {},
  "deliverability": {},
  "suppressions": {},
  "failures": {
    "notSent": [],
    "recentNotSent": [],
    "recentProviderEvents": []
  },
  "webhooks": []
}
GET/analytics
API-Schlüssel

Sende-Analytics des Dashboards für 7, 30 oder 90 Tage abrufen

Summen für gesendete, empfangene, zugestellte, gebouncte, blockierte, geöffnete, angeklickte E-Mails und Beschwerden im Zeitraum, eine Tages-Timeline für gesendete/empfangene E-Mails, die Top-Absenderdomains und die erfolgreichsten Betreffzeilen.

Query-Parameterdays
Anfrage
curl https://sendhq.cc/api/v1/analytics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Antwort 200
{
  "window": "30d",
  "days": 30,
  "metrics": {
    "sent": 0,
    "received": 0,
    "bounced": 0,
    "blocked": 0,
    "delivered": 0,
    "opened": 0,
    "clicks": 0,
    "complaints": 0
  },
  "timeline": [],
  "domains": [],
  "topContent": []
}
GET/profile
Browser-Sitzung

Konto, Nutzung und gestapelten Abonnementstatus abrufen

Konto, Nutzung und gestapelten Abonnementstatus abrufen

Anfrage
curl https://sendhq.cc/api/v1/profile \
  -X GET \
  -H "Cookie: sendhq_session_v2=…"
Antwort 200
{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "billing": {},
  "plans": []
}
POST/billing/checkout
Browser-Sitzung

Gehosteten Checkout für einen noch nicht gebuchten Tarif starten (Stufe, Nachrichtenklasse und Abrechnungsintervall)

Gehosteten Checkout für einen noch nicht gebuchten Tarif starten (Stufe, Nachrichtenklasse und Abrechnungsintervall)

Anfrage
curl https://sendhq.cc/api/v1/billing/checkout \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"plan_key":"scaleup_marketing_annual"}'
Antwort 200
{
  "url": "https://checkout.example/…",
  "session_id": "…"
}
POST/billing/cancel
Browser-Sitzung

Aktuelles Abonnement in der App kündigen, ohne den Provider anzutasten

Aktuelles Abonnement in der App kündigen, ohne den Provider anzutasten

Anfrage
curl https://sendhq.cc/api/v1/billing/cancel \
  -X POST \
  -H "Cookie: sendhq_session_v2=…"
Antwort 200
{
  "ok": true
}
POST/keys
Browser-Sitzung

API-Schlüssel erstellen

API-Schlüssel erstellen

Anfrage
curl https://sendhq.cc/api/v1/keys \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'
Antwort 201
{
  "id": "key_…",
  "name": "Production",
  "key": "re_…",
  "prefix": "re_…"
}
GET/keys
API-Schlüssel

Metadaten von API-Schlüsseln auflisten

Listet Schlüsselnamen, nicht geheime Präfixe und Zeitstempel der letzten Nutzung auf. Vollständige Schlüsselwerte werden nie zurückgegeben. Zum Erstellen und Widerrufen von Schlüsseln ist eine Dashboard-Sitzung erforderlich.

Anfrage
curl https://sendhq.cc/api/v1/keys \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Antwort 200
{
  "data": [],
  "count": 0
}
DELETE/keys/:id
Browser-Sitzung

API-Schlüssel widerrufen

API-Schlüssel widerrufen

Anfrage
curl https://sendhq.cc/api/v1/keys/id_value \
  -X DELETE \
  -H "Cookie: sendhq_session_v2=…"
Antwort 200
{
  "ok": true
}