API reference

One contract for the complete customer surface.

Customer endpoints are available under /api/v1. The legacy /api prefix remains available to the dashboard, while new server integrations should use the versioned base URL.

63 documented operations8 resource groupsOpenAPI 3.1 machine-readable contract

Authentication boundaries

Product integrations use a workspace API key, which can also read account usage, analytics, and API-key metadata. Billing changes and API-key creation or revocation require the HTTP-only browser session and are labeled accordingly.

Resources

Error envelope

JSON errors use one predictable envelope. Status codes distinguish invalid input, authentication, missing resources, conflicts, payment requirements, safety blocks, and usage limits.

Error response
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Versioning

The date-based API version identifies this contract. Backward-compatible fields can be added within the version. Breaking changes require a new versioned base path and a documented transition.

Discovery
{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}