Referencia de la API

Cuenta y facturación

Lea el uso de la cuenta, las analíticas y los metadatos de las claves con una clave de API; los cambios de facturación y la creación o revocación de claves requieren una sesión del panel.

GET/account
Clave de API

Obtener la cuenta, el uso, el estado de facturación y el número de espacios de trabajo con una clave de API

Equivalente con clave de API del perfil del panel: el titular de la cuenta, el uso de destinatarios y adjuntos del periodo actual frente a los límites del plan, el nivel de acceso, el resumen de reputación del remitente, el estado de la suscripción, los planes publicados y el número de espacios de trabajo. Solo lectura; los cambios de facturación siguen requiriendo una sesión.

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

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.

Solicitud
curl https://sendhq.cc/api/v1/account/diagnostics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 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
Clave de API

Obtener las analíticas de envío del panel para 7, 30 o 90 días

Totales de enviados, recibidos, entregados, rebotados, bloqueados, abiertos, clics y quejas en el periodo, una cronología diaria de enviados/recibidos, los principales dominios de envío y los asuntos con mejor rendimiento.

Parámetros de consultadays
Solicitud
curl https://sendhq.cc/api/v1/analytics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 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
Sesión del navegador

Obtener la cuenta, el uso y el estado de las suscripciones acumuladas

Obtener la cuenta, el uso y el estado de las suscripciones acumuladas

Solicitud
curl https://sendhq.cc/api/v1/profile \
  -X GET \
  -H "Cookie: sendhq_session_v2=…"
Respuesta 200
{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "billing": {},
  "plans": []
}
POST/billing/checkout
Sesión del navegador

Iniciar una página de pago alojada para un plan que aún no se tiene (nivel, clase de mensaje e intervalo de facturación)

Iniciar una página de pago alojada para un plan que aún no se tiene (nivel, clase de mensaje e intervalo de facturación)

Solicitud
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"}'
Respuesta 200
{
  "url": "https://checkout.example/…",
  "session_id": "…"
}
POST/billing/cancel
Sesión del navegador

Cancelar la suscripción actual desde la aplicación sin tocar el proveedor

Cancelar la suscripción actual desde la aplicación sin tocar el proveedor

Solicitud
curl https://sendhq.cc/api/v1/billing/cancel \
  -X POST \
  -H "Cookie: sendhq_session_v2=…"
Respuesta 200
{
  "ok": true
}
POST/keys
Sesión del navegador

Crear una clave de API

Crear una clave de API

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

Listar los metadatos de las claves de API

Lista los nombres de las claves, los prefijos no secretos y las marcas de tiempo del último uso. Los valores completos de las claves nunca se devuelven. Crear y revocar claves requiere una sesión del panel.

Solicitud
curl https://sendhq.cc/api/v1/keys \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 200
{
  "data": [],
  "count": 0
}
DELETE/keys/:id
Sesión del navegador

Revocar una clave de API

Revocar una clave de API

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